intercom 3.5.10 → 4.1.2

data/lib/intercom/scroll_collection_proxy.rb

@@ -1,32 +1,34 @@
-require "intercom/utils"
+# frozen_string_literal: true
 
-module Intercom
-  class ScrollCollectionProxy
+require 'intercom/utils'
+require 'intercom/base_collection_proxy'
 
-    attr_reader :resource_name, :scroll_url, :resource_class, :scroll_param, :records
+module Intercom
+  class ScrollCollectionProxy < BaseCollectionProxy
+    attr_reader :scroll_url, :scroll_param, :records
 
-    def initialize(resource_name, finder_details: {}, client:)
+    def initialize(resource_name, resource_class, details: {}, client:)
       @resource_name = resource_name
-      @resource_class = Utils.constantize_resource_name(resource_name)
-      @scroll_url = (finder_details[:url] || "/#{@resource_name}") + '/scroll'
+      @resource_class = resource_class
+      @scroll_url = (details[:url] || "/#{@resource_name}") + '/scroll'
       @client = client
-
     end
 
-    def next(scroll_parameter=nil)
+    def next(scroll_parameter = nil)
       @records = []
-      if not scroll_parameter
-        #First time so do initial get without scroll_param
-        response_hash = @client.get(@scroll_url, '')
-      else
-        #Not first call so use get next page
-        response_hash = @client.get(@scroll_url, scroll_param: scroll_parameter)
-      end
-      raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
+      response_hash = if !scroll_parameter
+                        # First time so do initial get without scroll_param
+                        @client.get(@scroll_url, '')
+                      else
+                        # Not first call so use get next page
+                        @client.get(@scroll_url, scroll_param: scroll_parameter)
+                      end
+      raise Intercom::HttpError, 'Http Error - No response entity returned' unless response_hash
+
       @scroll_param = extract_scroll_param(response_hash)
-      top_level_entity_key = deserialize_response_hash(response_hash)
+      top_level_entity_key = entity_key_from_response(response_hash)
       response_hash[top_level_entity_key] = response_hash[top_level_entity_key].map do |object_json|
-        Lib::TypedJsonDeserializer.new(object_json).deserialize
+        Lib::TypedJsonDeserializer.new(object_json, @client).deserialize
       end
       @records = response_hash[@resource_name]
       self
@@ -35,47 +37,41 @@ module Intercom
     def each(&block)
       scroll_param = nil
       loop do
-        if not scroll_param
-          response_hash = @client.get(@scroll_url, '')
-        else
-          response_hash = @client.get(@scroll_url, scroll_param: scroll_param)
-        end
-        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
-        response_hash[deserialize_response_hash(response_hash)].each do |object_json|
-          block.call Lib::TypedJsonDeserializer.new(object_json).deserialize
+        response_hash = if !scroll_param
+                          @client.get(@scroll_url, '')
+                        else
+                          @client.get(@scroll_url, scroll_param: scroll_param)
+                        end
+        raise Intercom::HttpError, 'Http Error - No response entity returned' unless response_hash
+
+        top_level_entity_key = entity_key_from_response(response_hash)
+        response_hash[top_level_entity_key].each do |object_json|
+          block.call Lib::TypedJsonDeserializer.new(object_json, @client).deserialize
         end
         scroll_param = extract_scroll_param(response_hash)
-        break if not records_present?(response_hash)
+        break unless records_present?(response_hash)
       end
       self
     end
 
-    def [](target_index)
-      self.each_with_index do |item, index|
-        return item if index == target_index
-      end
-      nil
-    end
-
-    include Enumerable
-
     private
 
-    def deserialize_response_hash(response_hash)
-      top_level_type = response_hash.delete('type')
+    def entity_key_from_response(response_hash)
+      top_level_type = response_hash['type']
       if resource_name == 'subscriptions'
-        top_level_entity_key = 'items'
+        'items'
       else
-        top_level_entity_key = Utils.entity_key_from_type(top_level_type)
+        Utils.entity_key_from_type(top_level_type)
       end
     end
 
     def records_present?(response_hash)
-      (response_hash[@resource_name].length > 0)
+      !response_hash[entity_key_from_response(response_hash)].empty?
     end
 
     def extract_scroll_param(response_hash)
       return nil unless records_present?(response_hash)
+
       response_hash['scroll_param']
     end
   end

data/lib/intercom/search_collection_proxy.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'intercom/utils'
+require 'intercom/base_collection_proxy'
+
+module Intercom
+  class SearchCollectionProxy < BaseCollectionProxy
+    def initialize(resource_name, resource_class, details: {}, client:)
+      super(resource_name, resource_class, details: details, client: client, method: 'post')
+    end
+
+    private
+
+    def payload
+      payload = {
+        query: @params[:query]
+      }
+      if sort_field || sort_order
+        payload[:sort] = {}
+        payload[:sort][:field] = sort_field if sort_field
+        payload[:sort][:order] = sort_order if sort_order
+      end
+      if per_page || starting_after
+        payload[:pagination] = {}
+        payload[:pagination][:per_page] = per_page if per_page
+        payload[:pagination][:starting_after] = starting_after if starting_after
+      end
+      payload
+    end
+
+    def sort_field
+      @params[:sort_field]
+    end
+
+    def sort_order
+      @params[:sort_order]
+    end
+
+    def per_page
+      @params[:per_page]
+    end
+
+    def starting_after
+      @params[:starting_after]
+    end
+  end
+end

data/lib/intercom/section.rb

@@ -0,0 +1,23 @@
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/save'
+require 'intercom/api_operations/delete'
+
+module Intercom
+  module Service
+    class Section < BaseService
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::Save
+      include ApiOperations::Delete
+
+      def collection_class
+        Intercom::Section
+      end
+
+      def collection_name
+        'help_center/sections'
+      end
+    end
+  end
+end

data/lib/intercom/segment.rb

@@ -3,5 +3,9 @@ require 'intercom/traits/api_resource'
 module Intercom
   class Segment
     include Traits::ApiResource
+
+    def self.collection_proxy_class
+      Intercom::BaseCollectionProxy
+    end
   end
 end

data/lib/intercom/service/article.rb

@@ -0,0 +1,20 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/delete'
+require 'intercom/api_operations/save'
+
+module Intercom
+  module Service
+    class Article < BaseService
+      include ApiOperations::Find
+      include ApiOperations::List
+      include ApiOperations::Delete
+      include ApiOperations::Save
+
+      def collection_class
+        Intercom::Article
+      end
+    end
+  end
+end

data/lib/intercom/service/base_service.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'intercom/client_collection_proxy'
+
 module Intercom
   module Service
     class BaseService
@@ -11,8 +15,17 @@ module Intercom
         raise NotImplementedError
       end
 
+      def collection_proxy_class
+        Intercom::ClientCollectionProxy
+      end
+
+      def collection_name
+        @collection_name ||= Utils.resource_class_to_collection_name(collection_class)
+      end
+
       def from_api(api_response)
         object = collection_class.new
+        object.client = @client
         object.from_response(api_response)
         object
       end

data/lib/intercom/service/collection.rb

@@ -0,0 +1,24 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/delete'
+require 'intercom/api_operations/save'
+
+module Intercom
+  module Service
+    class Collection < BaseService
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::Delete
+      include ApiOperations::Save
+
+      def collection_class
+        Intercom::Collection
+      end
+
+      def collection_name
+        "help_center/collections"
+      end
+    end
+  end
+end

data/lib/intercom/service/company.rb

@@ -1,22 +1,24 @@
 require 'intercom/service/base_service'
+require 'intercom/api_operations/delete'
 require 'intercom/api_operations/list'
+require 'intercom/api_operations/scroll'
 require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/load'
-require 'intercom/extended_api_operations/users'
 require 'intercom/extended_api_operations/tags'
 require 'intercom/extended_api_operations/segments'
 
 module Intercom
   module Service
     class Company < BaseService
+      include ApiOperations::Delete
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Load
       include ApiOperations::List
+      include ApiOperations::Scroll
       include ApiOperations::Save
-      include ExtendedApiOperations::Users
       include ExtendedApiOperations::Tags
       include ExtendedApiOperations::Segments
 

data/lib/intercom/service/contact.rb

@@ -2,11 +2,9 @@ require 'intercom/service/base_service'
 require 'intercom/api_operations/load'
 require 'intercom/api_operations/list'
 require 'intercom/api_operations/find'
-require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
-require 'intercom/api_operations/scroll'
-require 'intercom/api_operations/convert'
 require 'intercom/api_operations/delete'
+require 'intercom/api_operations/search'
 
 module Intercom
   module Service
@@ -14,15 +12,40 @@ module Intercom
       include ApiOperations::Load
       include ApiOperations::List
       include ApiOperations::Find
-      include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Scroll
-      include ApiOperations::Convert
       include ApiOperations::Delete
+      include ApiOperations::Search
 
       def collection_class
         Intercom::Contact
       end
+
+      def collection_proxy_class
+        Intercom::BaseCollectionProxy
+      end
+
+      def merge(lead, user)
+        raise_invalid_merge_error unless lead.role == 'lead' && user.role == 'user'
+
+        response = @client.post('/contacts/merge', from: lead.id, into: user.id)
+        raise Intercom::HttpError, 'Http Error - No response entity returned' unless response
+
+        user.from_response(response)
+      end
+
+      def archive(contact)
+        @client.post("/#{collection_name}/#{contact.id}/archive", {})
+        contact
+      end
+
+      def unarchive(contact)
+        @client.post("/#{collection_name}/#{contact.id}/unarchive", {})
+        contact
+      end
+
+      private def raise_invalid_merge_error
+        raise Intercom::InvalidMergeError, 'Merging can only be performed on a lead into a user'
+      end
     end
   end
 end

data/lib/intercom/service/conversation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/service/base_service'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/find'
@@ -9,9 +11,11 @@ module Intercom
   module Service
     class Conversation < BaseService
       include ApiOperations::FindAll
+      include ApiOperations::List
       include ApiOperations::Find
       include ApiOperations::Load
       include ApiOperations::Save
+      include ApiOperations::Search
 
       def collection_class
         Intercom::Conversation
@@ -24,7 +28,13 @@ module Intercom
       def reply(reply_data)
         id = reply_data.delete(:id)
         collection_name = Utils.resource_class_to_collection_name(collection_class)
-        response = @client.post("/#{collection_name}/#{id}/reply", reply_data.merge(:conversation_id => id))
+        response = @client.post("/#{collection_name}/#{id}/reply", reply_data.merge(conversation_id: id))
+        collection_class.new.from_response(response)
+      end
+
+      def reply_to_last(reply_data)
+        collection_name = Utils.resource_class_to_collection_name(collection_class)
+        response = @client.post("/#{collection_name}/last/reply", reply_data)
         collection_class.new.from_response(response)
       end
 
@@ -36,10 +46,21 @@ module Intercom
         reply reply_data.merge(message_type: 'close', type: 'admin')
       end
 
+      def snooze(reply_data)
+        reply_data.fetch(:snoozed_until) { raise 'snoozed_until field is required' }
+        reply reply_data.merge(message_type: 'snoozed', type: 'admin')
+      end
+
       def assign(reply_data)
-        assignee_id = reply_data.fetch(:assignee_id) { fail 'assignee_id is required' }
+        assignee_id = reply_data.fetch(:assignee_id) { raise 'assignee_id is required' }
         reply reply_data.merge(message_type: 'assignment', assignee_id: assignee_id, type: 'admin')
       end
+
+      def run_assignment_rules(id)
+        collection_name = Utils.resource_class_to_collection_name(collection_class)
+        response = @client.post("/#{collection_name}/#{id}/run_assignment_rules", {})
+        collection_class.new.from_response(response)
+      end
     end
   end
 end

data/lib/intercom/service/data_attribute.rb

@@ -0,0 +1,20 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/load'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/save'
+
+module Intercom
+  module Service
+    class DataAttribute < BaseService
+      include ApiOperations::Load
+      include ApiOperations::List
+      include ApiOperations::FindAll
+      include ApiOperations::Save
+
+      def collection_class
+        Intercom::DataAttribute
+      end
+    end
+  end
+end

data/lib/intercom/service/event.rb

@@ -1,8 +1,16 @@
+require 'intercom/client_collection_proxy'
 require 'intercom/service/base_service'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/bulk/submit'
 
 module Intercom
+  class EventCollectionProxy < ClientCollectionProxy
+
+    def paging_info_present?(response_hash)
+      !!(response_hash['pages'])
+    end
+  end
+
   module Service
     class Event < BaseService
       include ApiOperations::FindAll
@@ -12,6 +20,10 @@ module Intercom
       def collection_class
         Intercom::Event
       end
+
+      def collection_proxy_class
+        Intercom::EventCollectionProxy
+      end
     end
   end
 end