intercom 4.1.1 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa157332954bf84fd08a22313a71f4435b78336674c268829a64e1c14995dc3
-  data.tar.gz: e5773633f34167729c300fe0906c2cb2550f8e90f69aaf43a8142e08386b455f
+  metadata.gz: ebb883bd25fc8d132306baac3a22c43650701dbe42d42b95ada3819bc52cc2d6
+  data.tar.gz: 8d1158c4d79cf19916c6cc1d413c329588d1ff36b5741517e029415e0f992360
 SHA512:
-  metadata.gz: d1b492cab3734c3b2a2f861cf481e64f86b7f7179c80f82f5c4f187fcf6579eba2f2bfa1a948160bdac8142262e491942c036b894e400f7833310a119677936c
-  data.tar.gz: e6d5b2f5dc751ed7f8b12e4ade49164d3d28831cb8f2ec4d30d15780c2c74b5bc5a4a48680a14136e1505a8a1f773649ea8df65f7703eb0fb7ce6c0d74050ade
+  metadata.gz: 0a0ea848ac117043da9707f2f9689504abda06f34e218a077c0591216aa654c3e9ca73f9874f2255e7300cd3329c95ba6440232c30d58364877e7d358bf950d0
+  data.tar.gz: 95b5ffdd05e7332fcbd53061c08c380d8632bd9f11d09e3673da65ca25b4624377b409116292b41f626a0fc6b4ad3d1c5183e5315533d3b4f94fe285c74041a6

data/README.md

@@ -86,6 +86,12 @@ intercom.contacts.save(contact)
 contact.role = "user"
 intercom.contacts.save(contact)
 
+# Archive a contact
+intercom.contacts.archive(contact)
+
+# Unarchive a contact
+intercom.contacts.unarchive(contact)
+
 # Delete a contact permanently
 intercom.contacts.delete(contact)
 
@@ -125,6 +131,9 @@ contact.create_note(body: "<p>Text for the note</p>")
 # List notes for a contact
 contact.notes.each {|n| p n.body}
 
+# List segments for a contact
+contact.segments.each {|segment| p segment.name}
+
 # Add a contact to a company
 company = intercom.companies.find(id: "123")
 contact.add_company(id: company.id)
@@ -166,6 +175,9 @@ company = intercom.companies.find(id: "41e66f0313708347cb0000d0")
 company.name = 'Updated company name'
 intercom.companies.save(company)
 
+# Delete a company
+intercom.companies.delete(company)
+
 # Iterate over all companies
 intercom.companies.all.each {|company| puts %Q(#{company.name} - #{company.custom_attributes["referral_source"]}) }
 intercom.companies.all.map {|company| company.name }
@@ -261,6 +273,9 @@ intercom.tags.all.map {|tag| tag.name }
 
 # Tag companies
 tag = intercom.tags.tag(name: 'blue', companies: [{company_id: "42ea2f1b93891f6a99000427"}])
+
+# Untag Companies
+tag = intercom.tags.untag(name: 'blue', companies: [{ company_id: "42ea2f1b93891f6a99000427" }])
 ```
 
 #### Notes

data/changes.txt

@@ -1,3 +1,6 @@
+4.1.1
+- Fixed bug with deprecated lead resource.
+
 4.1.0
 - Added support for new Articles API.
 - Added support for new Collections API.

data/lib/intercom/contact.rb

@@ -13,6 +13,7 @@ module Intercom
     nested_resource_methods :tag, operations: %i[add delete list]
     nested_resource_methods :note, operations: %i[create list]
     nested_resource_methods :company, operations: %i[add delete list]
+    nested_resource_methods :segment, operations: %i[list]
 
     def self.collection_proxy_class
       Intercom::BaseCollectionProxy

data/lib/intercom/scroll_collection_proxy.rb

@@ -26,7 +26,7 @@ module Intercom
       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, @client).deserialize
       end
@@ -44,7 +44,8 @@ module Intercom
                         end
         raise Intercom::HttpError, 'Http Error - No response entity returned' unless response_hash
 
-        response_hash[deserialize_response_hash(response_hash)].each do |object_json|
+        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)
@@ -55,8 +56,8 @@ module Intercom
 
     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'
         'items'
       else
@@ -65,7 +66,7 @@ module Intercom
     end
 
     def records_present?(response_hash)
-      !response_hash[@resource_name].empty?
+      !response_hash[entity_key_from_response(response_hash)].empty?
     end
 
     def extract_scroll_param(response_hash)

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/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

data/lib/intercom/service/contact.rb

@@ -33,6 +33,16 @@ module Intercom
         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

data/lib/intercom/service/conversation.rb

@@ -58,7 +58,7 @@ module Intercom
 
       def run_assignment_rules(id)
         collection_name = Utils.resource_class_to_collection_name(collection_class)
-        response = @client.post("/#{collection_name}/#{id}/run_assignment_rules")
+        response = @client.post("/#{collection_name}/#{id}/run_assignment_rules", {})
         collection_class.new.from_response(response)
       end
     end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "4.1.1"
+  VERSION = "4.1.2"
 end

data/spec/unit/intercom/company_spec.rb

@@ -35,4 +35,10 @@ describe Intercom::Company do
     _(proxy.url).must_equal '/companies/1/contacts'
     _(proxy.resource_class).must_equal Intercom::Contact
   end
+
+  it "deletes a company" do
+    company = Intercom::Company.new("id" => "1")
+    client.expects(:delete).with("/companies/1", {})
+    client.companies.delete(company)
+  end
 end

data/spec/unit/intercom/contact_spec.rb

@@ -248,6 +248,18 @@ describe Intercom::Contact do
     client.contacts.delete(contact)
   end
 
+  it 'archives a contact' do
+    contact = Intercom::Contact.new('id' => '1')
+    client.expects(:post).with('/contacts/1/archive', {})
+    client.contacts.archive(contact)
+  end
+
+  it 'unarchives a contact' do
+    contact = Intercom::Contact.new('id' => '1')
+    client.expects(:post).with('/contacts/1/unarchive', {})
+    client.contacts.unarchive(contact)
+  end
+
   describe 'merging' do
     let(:lead) { Intercom::Contact.from_api(external_id: 'contact_id', role: 'lead') }
     let(:user) { Intercom::Contact.from_api(id: 'external_id', role: 'user') }
@@ -273,6 +285,13 @@ describe Intercom::Contact do
       _(proxy.resource_class).must_equal Intercom::Note
     end
 
+    it 'returns a collection proxy for listing segments' do
+      proxy = contact.segments
+      _(proxy.resource_name).must_equal 'segments'
+      _(proxy.url).must_equal '/contacts/1/segments'
+      _(proxy.resource_class).must_equal Intercom::Segment
+    end
+
     it 'returns a collection proxy for listing tags' do
       proxy = contact.tags
       _(proxy.resource_name).must_equal 'tags'

data/spec/unit/intercom/conversation_spec.rb

@@ -54,7 +54,7 @@ describe "Intercom::Conversation" do
   end
 
   it 'runs assignment rules on a conversation' do
-    client.expects(:post).with('/conversations/147/run_assignment_rules').returns(test_conversation)
+    client.expects(:post).with('/conversations/147/run_assignment_rules', {}).returns(test_conversation)
     client.conversations.run_assignment_rules('147')
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.1.2
 platform: ruby
 authors:
 - Ben McRedmond
@@ -12,10 +12,10 @@ authors:
 - Declan McGrath
 - Jamie Osler
 - Bob Long
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -256,7 +256,7 @@ homepage: https://www.intercom.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -272,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby bindings for the Intercom API
 test_files: