intercom 3.9.5 → 4.1.3

data/lib/intercom/search_collection_proxy.rb

@@ -1,82 +1,47 @@
-require "intercom/utils"
+# frozen_string_literal: true
 
-module Intercom
-  class SearchCollectionProxy
-
-    attr_reader :resource_name, :resource_class
-
-    def initialize(resource_name, search_details: {}, client:)
-      @resource_name = resource_name
-      @resource_class = Utils.constantize_resource_name(resource_name)
-      @search_url = search_details[:url]
-      @search_params = search_details[:params]
-      @client = client
-    end
-
-    def each(&block)
-      loop do
-        response_hash = @client.post(@search_url, payload)
-        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
-        deserialize_response_hash(response_hash, block)
-        break unless has_next_link?(response_hash)
-      end
-      self
-    end
+require 'intercom/utils'
+require 'intercom/base_collection_proxy'
 
-    def [](target_index)
-      self.each_with_index do |item, index|
-        return item if index == target_index
-      end
-      nil
+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
 
-    include Enumerable
-
     private
 
-    def deserialize_response_hash(response_hash, block)
-      top_level_type = response_hash.delete('type')
-      top_level_entity_key = Utils.entity_key_from_type(top_level_type)
-      response_hash[top_level_entity_key].each do |object_json|
-        block.call Lib::TypedJsonDeserializer.new(object_json).deserialize
-      end
-    end
-
-    def has_next_link?(response_hash)
-      paging_info = response_hash.delete('pages')
-      paging_next = paging_info["next"]
-      if paging_next
-        @search_params[:starting_after] = paging_next["starting_after"]
-        return true
-      else
-        return false
-      end
-    end
-
     def payload
       payload = {
-        query: @search_params[:query]
+        query: @params[:query]
       }
-      if @search_params[:sort_field] || @search_params[:sort_order]
+      if sort_field || sort_order
         payload[:sort] = {}
-        if @search_params[:sort_field]
-          payload[:sort][:field] = @search_params[:sort_field]
-        end
-        if @search_params[:sort_order]
-          payload[:sort][:order] = @search_params[:sort_order]
-        end
+        payload[:sort][:field] = sort_field if sort_field
+        payload[:sort][:order] = sort_order if sort_order
       end
-      if @search_params[:per_page] || @search_params[:starting_after]
+      if per_page || starting_after
         payload[:pagination] = {}
-        if @search_params[:per_page]
-          payload[:pagination][:per_page] = @search_params[:per_page]
-        end
-        if @search_params[:starting_after]
-          payload[:pagination][:starting_after] = @search_params[:starting_after]
-        end
+        payload[:pagination][:per_page] = per_page if per_page
+        payload[:pagination][:starting_after] = starting_after if starting_after
       end
-      return payload
+      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,5 @@
+# frozen_string_literal: true
+
 require 'intercom/client_collection_proxy'
 
 module Intercom
@@ -17,8 +19,13 @@ module Intercom
         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,4 +1,5 @@
 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'
@@ -11,6 +12,7 @@ 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
@@ -23,18 +25,6 @@ module Intercom
       def collection_class
         Intercom::Company
       end
-
-      def users_by_intercom_company_id(id)
-        get_users(url: "/companies/#{id}/users")
-      end
-
-      def users_by_company_id(id)
-        get_users(url: "/companies", params: { company_id: id, type: "user" })
-      end
-
-      private def get_users(url:, params: {})
-        ClientCollectionProxy.new("users", finder_details: { url: url, params: params }, client: @client)
-      end
     end
   end
 end

data/lib/intercom/service/contact.rb

@@ -2,12 +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/archive'
-require 'intercom/api_operations/request_hard_delete'
+require 'intercom/api_operations/delete'
+require 'intercom/api_operations/search'
 
 module Intercom
   module Service
@@ -15,16 +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::Archive
-      include ApiOperations::RequestHardDelete
+      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'
@@ -13,6 +15,7 @@ module Intercom
       include ApiOperations::Find
       include ApiOperations::Load
       include ApiOperations::Save
+      include ApiOperations::Search
 
       def collection_class
         Intercom::Conversation
@@ -25,7 +28,7 @@ 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
 
@@ -44,14 +47,20 @@ module Intercom
       end
 
       def snooze(reply_data)
-        snoozed_until = reply_data.fetch(:snoozed_until) { fail 'snoozed_until field is required' }
+        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/lead.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+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/archive'
+require 'intercom/api_operations/request_hard_delete'
+require 'intercom/deprecated_leads_collection_proxy'
+
+module Intercom
+  module Service
+    class Lead < BaseService
+      include ApiOperations::Load
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::FindAll
+      include ApiOperations::Save
+      include ApiOperations::Scroll
+      include ApiOperations::Convert
+      include ApiOperations::Archive
+      include ApiOperations::RequestHardDelete
+
+      def collection_proxy_class
+        Intercom::DeprecatedLeadsCollectionProxy
+      end
+
+      def collection_class
+        Intercom::Lead
+      end
+
+      def collection_name
+        'contacts'
+      end
+    end
+  end
+end

data/lib/intercom/service/note.rb

@@ -1,22 +1,18 @@
 require 'intercom/service/base_service'
-require 'intercom/api_operations/list'
-require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/find'
-require 'intercom/api_operations/load'
-require 'intercom/api_operations/save'
 
 module Intercom
   module Service
     class Note < BaseService
-      include ApiOperations::Save
-      include ApiOperations::List
-      include ApiOperations::FindAll
       include ApiOperations::Find
-      include ApiOperations::Load
 
       def collection_class
         Intercom::Note
       end
+
+      def collection_proxy_class
+        Intercom::BaseCollectionProxy
+      end
     end
   end
 end

data/lib/intercom/service/section.rb

@@ -0,0 +1,7 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Section
+    include Traits::ApiResource
+  end
+end

data/lib/intercom/service/subscription.rb

@@ -2,7 +2,7 @@ require 'intercom/api_operations/list'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/find'
 require 'intercom/api_operations/save'
-require 'intercom/api_operations/archive'
+require 'intercom/api_operations/delete'
 
 module Intercom
   module Service
@@ -11,7 +11,7 @@ module Intercom
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Archive
+      include ApiOperations::Delete
 
       def collection_class
         Intercom::Subscription

data/lib/intercom/service/tag.rb

@@ -2,6 +2,7 @@ require 'intercom/service/base_service'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/list'
 require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/find'
 
 module Intercom
   module Service
@@ -9,12 +10,17 @@ module Intercom
       include ApiOperations::Save
       include ApiOperations::List
       include ApiOperations::FindAll
-      include ApiOperations::Archive
+      include ApiOperations::Delete
+      include ApiOperations::Find
 
       def collection_class
         Intercom::Tag
       end
 
+      def collection_proxy_class
+        Intercom::BaseCollectionProxy
+      end
+
       def tag(params)
         params['tag_or_untag'] = 'tag'
         create(params)
@@ -22,17 +28,11 @@ module Intercom
 
       def untag(params)
         params['tag_or_untag'] = 'untag'
-        users_or_companies(params).each do |user_or_company|
-          user_or_company[:untag] = true
+        params[:companies].each do |company|
+          company[:untag] = true
         end
         create(params)
       end
-
-      private
-
-      def users_or_companies(params)
-        params[:users] || params[:companies]
-      end
     end
   end
 end

data/lib/intercom/service/visitor.rb

@@ -1,26 +1,35 @@
 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/convert'
-require 'intercom/api_operations/archive'
+require 'intercom/api_operations/delete'
 
 module Intercom
   module Service
     class Visitor < BaseService
       include ApiOperations::Load
-      include ApiOperations::List
       include ApiOperations::Find
-      include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Convert
-      include ApiOperations::Archive
+      include ApiOperations::Delete
 
       def collection_class
         Intercom::Visitor
       end
+
+      def convert(visitor, contact = false)
+        req = { visitor: { user_id: visitor.user_id } }
+        if contact
+          req[:user] = identity_hash(contact)
+          req[:type] = 'user'
+        else
+          req[:type] = 'lead'
+        end
+        Intercom::Contact.new.from_response(
+          @client.post(
+            "/visitors/convert", req
+          )
+        )
+      end
     end
   end
 end

data/lib/intercom/tag.rb

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