intercom 3.9.5 → 4.1.2

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

data/lib/intercom/traits/api_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/lib/flat_store'
 require 'intercom/lib/dynamic_accessors'
 require 'intercom/lib/dynamic_accessors_on_method_missing'
@@ -6,16 +8,19 @@ require 'intercom/lib/typed_json_deserializer'
 
 module Intercom
   module Traits
-
     module ApiResource
       include DirtyTracking
 
-      attr_accessor :id
+      attr_accessor :id, :client
 
       def initialize(attributes = {})
         from_hash(attributes)
       end
 
+      def ==(other)
+        self.class == other.class && to_json == other.to_json
+      end
+
       def from_response(response)
         from_hash(response)
         reset_changed_fields!
@@ -31,49 +36,71 @@ module Intercom
       end
 
       def to_hash
-        instance_variables_excluding_dirty_tracking_field.inject({}) do |hash, variable|
-          hash[variable.to_s.delete("@")] = instance_variable_get(variable)
-          hash
+        instance_variables_excluding_dirty_tracking_field.each_with_object({}) do |variable, hash|
+          hash[variable.to_s.delete('@')] = instance_variable_get(variable)
+        end
+      end
+
+      def to_json(*args)
+        instance_variables_excluding_dirty_tracking_field.each_with_object({}) do |variable, hash|
+          next if variable == :@client
+
+          value = instance_variable_get(variable)
+          hash[variable.to_s.delete('@')] = value.respond_to?(:to_json) ? value.to_json(*args) : value
         end
       end
 
       def to_submittable_hash
         submittable_hash = {}
         to_hash.each do |attribute, value|
-          submittable_hash[attribute] = value if submittable_attribute?(attribute, value)
+          next unless submittable_attribute?(attribute, value)
+
+          submittable_hash[attribute] = value.respond_to?(:to_submittable_hash) ? value.to_submittable_hash : value
         end
         submittable_hash
       end
 
       def method_missing(method_sym, *arguments, &block)
-        Lib::DynamicAccessorsOnMethodMissing.new(method_sym, *arguments, self).
-          define_accessors_or_call { super }
+        Lib::DynamicAccessorsOnMethodMissing.new(method_sym, *arguments, self)
+                                            .define_accessors_or_call { super }
       end
 
       def flat_store_attribute?(attribute)
-        (respond_to?(:flat_store_attributes)) && (flat_store_attributes.map(&:to_s).include?(attribute.to_s))
+        respond_to?(:flat_store_attributes) && flat_store_attributes.map(&:to_s).include?(attribute.to_s)
       end
 
       private
 
       def initialize_property(attribute, value)
+        return if addressable_list?(attribute, value)
+
         Lib::DynamicAccessors.define_accessors(attribute, value, self) unless accessors_already_defined?(attribute)
         set_property(attribute, value)
       end
 
+      def addressable_list?(attribute, value)
+        return false unless typed_property?(attribute, value)
+
+        value['type'] == 'list' && value['url']
+      end
+
       def accessors_already_defined?(attribute)
         respond_to?(attribute) && respond_to?("#{attribute}=")
       end
 
       def set_property(attribute, value)
+        value_to_set = parsed_value_for_attribute(attribute, value)
+        call_setter_for_attribute(attribute, value_to_set)
+      end
+
+      def parsed_value_for_attribute(attribute, value)
         if typed_property?(attribute, value)
-          value_to_set = Intercom::Lib::TypedJsonDeserializer.new(value).deserialize
+          Intercom::Lib::TypedJsonDeserializer.new(value, client).deserialize
         elsif flat_store_attribute?(attribute)
-          value_to_set = Intercom::Lib::FlatStore.new(value)
+          Intercom::Lib::FlatStore.new(value)
         else
-          value_to_set = value
+          value
         end
-        call_setter_for_attribute(attribute, value_to_set)
       end
 
       def custom_attribute_field?(attribute)
@@ -97,12 +124,12 @@ module Intercom
       end
 
       def typed_value?(value)
-        value.is_a? Hash and !!value['type']
+        value.is_a?(Hash) && !!value['type']
       end
 
       def call_setter_for_attribute(attribute, value)
-        setter_method = "#{attribute.to_s}="
-        self.send(setter_method, value)
+        setter_method = "#{attribute}="
+        send(setter_method, value)
       end
 
       def initialize_missing_flat_store_attributes
@@ -120,7 +147,7 @@ module Intercom
 
       module ClassMethods
         def from_api(api_response)
-          object = self.new
+          object = new
           object.from_response(api_response)
           object
         end
@@ -129,7 +156,6 @@ module Intercom
       def self.included(base)
         base.extend(ClassMethods)
       end
-
     end
   end
 end