intercom 3.6.2 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb279cee47b8721db490a1cc48254cd0c77ce2f5
-  data.tar.gz: 7c4692eec6c02dff011cc59a3c59e8cbed2623f9
+  metadata.gz: a6e8da86f1e16e4bce5f0f6fea61822905d6a6d8
+  data.tar.gz: ccbbde9ad1055d33b6907e5d43157234656b79e8
 SHA512:
-  metadata.gz: ff17f1177da16e8d48d932ff27c48bec548a9e7d6ce2183657d1d8e5e21156826674d30557d644e5249f2f2c9f3151018ba1e69223e99a2b591d66a21f75ca66
-  data.tar.gz: e38a41bf57b2c4714197a4812458eb13080e4ef7acfec8c574feb10139d4a64f6fec737bb55f3979125c3c8e66d8d93179c8aa1f0f7112f97655a6e9e9975172
+  metadata.gz: 434adcd92c200092ff3ed4b2e5909bd56ff46e7732b7497bfd918b591a9a360ece881fb0fef152d04325fb6ecf6e50c8bb4f75d9d15fd5e867e6d10dba6f4098
+  data.tar.gz: 7363c7f504408438d3fe40556284cdd1a4869d927d3cbe2ffea117186898812eefbb45d4341d6c9f1c49094c5db5eccf366e1a4a19b8030b0079fb12db97afdd

data/README.md

@@ -22,7 +22,7 @@ This version of the gem is compatible with `Ruby 2.1` and above.
 
 Using bundler:
 
-    gem 'intercom', '~> 3.6.1'
+    gem 'intercom', '~> 3.7.0'
 
 ## Basic Usage
 
@@ -68,9 +68,13 @@ user = intercom.users.find(user_id: "1")
 user = intercom.users.find(id: "1")
 # Create a user
 user = intercom.users.create(email: "bob@example.com", name: "Bob Smith", signed_up_at: Time.now.to_i)
-# Delete a user
+# archive a user
 user = intercom.users.find(id: "1")
-deleted_user = intercom.users.delete(user)
+archived_user = intercom.users.archive(user)
+# request a hard delete for a user
+(https://developers.intercom.com/intercom-api-reference/reference#delete-users)
+user = intercom.users.find(id: "1")
+deleted_user = intercom.users.request_hard_delete(user)
 # Update custom_attributes for a user
 user.custom_attributes["average_monthly_spend"] = 1234.56
 intercom.users.save(user)
@@ -135,7 +139,7 @@ intercom.companies.all.map {|company| company.name }
 # Get a list of users in a company by Intercom Company ID
 intercom.companies.users_by_intercom_company_id(company.id)
 # Get a list of users in a company by external company_id
-intercom.companies.users_by_company_id(company.company_id) 
+intercom.companies.users_by_company_id(company.company_id)
 # Get a large list of companies using scroll
 intercom.companies.scroll.each { |comp| puts comp.name}
 # Please see users scroll for more details of how to use scroll
@@ -198,7 +202,7 @@ intercom.conversations.find_all(email: 'joe@example.com', type: 'user', unread:
 intercom.conversations.find_all(email: 'joe@example.com', type: 'user', unread: true).each {|convo| ... }
 # Iterate over all conversations for a user with their Intercom user ID
 intercom.conversations.find_all(intercom_user_id: '536e564f316c83104c000020', type: 'user').each {|convo| ... }
-# Iterate over all conversations for a lead 
+# Iterate over all conversations for a lead
 # NOTE: to iterate over a lead's conversations you MUST use their Intercom User ID and type User
 intercom.conversations.find_all(intercom_user_id: lead.id, type: 'user').each {|convo| ... }
 
@@ -228,7 +232,7 @@ intercom.conversations.open(id: conversation.id, admin_id: '123')
 intercom.conversations.close(id: conversation.id, admin_id: '123')
 
 # Assign
-# Note: Conversations can be assigned to teams. However, the entity that performs the operation of assigning the conversation has to be an existing teammate. 
+# Note: Conversations can be assigned to teams. However, the entity that performs the operation of assigning the conversation has to be an existing teammate.
 #       You can use `intercom.admins.all.each {|a| puts a.inspect if a.type == 'admin' }` to list all of your teammates.
 intercom.conversations.assign(id: conversation.id, admin_id: '123', assignee_id: '124')
 
@@ -372,12 +376,19 @@ The metadata key values in the example are treated as follows-
 ### Contacts
 
 `Contacts` represent logged out users of your application.
+Note that `contacts` are referred to as `leads` in the [Intercom](https://developers.intercom.com/intercom-api-reference/reference#leads)
 
 ```ruby
 # Create a contact
 contact = intercom.contacts.create(email: "some_contact@example.com")
 
-# Update a contact
+# Update a contact (via create method)
+# You can update a contact by calling the create method but you MUST provide an id or user_id
+# If you just provide an email, for example, it will create a new contact
+# See https://developers.intercom.com/intercom-api-reference/reference#update-lead for more detail
+contact = intercom.contacts.create(email: "some_contact@example.com", id: "3be0398668071a6bc6850413", name:"update_contact")
+
+# Update a contact (via contact object)
 contact.custom_attributes['foo'] = 'bar'
 intercom.contacts.save(contact)
 
@@ -410,8 +421,8 @@ contact = intercom.contacts.find(id: "536e564f316c83104c000020")
 intercom.contacts.convert(contact, Intercom::User.new(email: email))
 # Using find with email will not work here. See https://github.com/intercom/intercom-ruby/issues/419 for more information
 
-# Delete a contact
-intercom.contacts.delete(contact)
+# archive a contact
+intercom.contacts.archive(contact)
 
 # Get a large list of contacts using scroll
 intercom.contacts.scroll.each { |lead| puts lead.id}

data/changes.txt

@@ -1,3 +1,20 @@
+3.7.0
+Providing the ability to hard delete users as described here:
+https://developers.intercom.com/intercom-api-reference/reference#archive-a-user
+
+This chaged the previous delete action to an archive action and added a new hard delete option
+You can still use the delete method but it will archive a user, we added an alias for delete.
+#442 archiving alias
+#410 add ability to hard delete users
+
+Alos enabling reply to last from the SDK
+#443 Residently conversations last reply
+
+3.6.2
+#384 Add ability to snooze conversation
+You can now snooze conversations in your app via:
+intercom.conversations.snooze(...)
+
 3.6.1
 #430 Allow all conversations to be listed
 You can now iterate over all conversations for your app via:

data/lib/intercom/api_operations/{delete.rb → archive.rb}

@@ -2,12 +2,14 @@ require 'intercom/utils'
 
 module Intercom
   module ApiOperations
-    module Delete
-      def delete(object)
+    module Archive
+      def archive(object)
         collection_name = Utils.resource_class_to_collection_name(collection_class)
         @client.delete("/#{collection_name}/#{object.id}", {})
         object
       end
+
+      alias_method 'delete', 'archive'
     end
   end
 end

data/lib/intercom/api_operations/request_hard_delete.rb

@@ -0,0 +1,12 @@
+require 'intercom/utils'
+
+module Intercom
+  module ApiOperations
+    module RequestHardDelete
+      def request_hard_delete(object)
+        @client.post("/user_delete_requests", {intercom_user_id: object.id})
+        object
+      end
+    end
+  end
+end

data/lib/intercom/service/contact.rb

@@ -6,7 +6,8 @@ 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/archive'
+require 'intercom/api_operations/request_hard_delete'
 
 module Intercom
   module Service
@@ -18,7 +19,8 @@ module Intercom
       include ApiOperations::Save
       include ApiOperations::Scroll
       include ApiOperations::Convert
-      include ApiOperations::Delete
+      include ApiOperations::Archive
+      include ApiOperations::RequestHardDelete
 
       def collection_class
         Intercom::Contact

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/delete'
+require 'intercom/api_operations/archive'
 
 module Intercom
   module Service
@@ -11,7 +11,7 @@ module Intercom
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Subscription

data/lib/intercom/service/tag.rb

@@ -9,7 +9,7 @@ module Intercom
       include ApiOperations::Save
       include ApiOperations::List
       include ApiOperations::FindAll
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Tag

data/lib/intercom/service/user.rb

@@ -5,8 +5,9 @@ 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/delete'
+require 'intercom/api_operations/archive'
 require 'intercom/api_operations/bulk/submit'
+require 'intercom/api_operations/request_hard_delete'
 require 'intercom/extended_api_operations/tags'
 require 'intercom/extended_api_operations/segments'
 
@@ -19,7 +20,8 @@ module Intercom
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Delete
+      include ApiOperations::Archive
+      include ApiOperations::RequestHardDelete
       include ApiOperations::Bulk::Submit
       include ExtendedApiOperations::Tags
       include ExtendedApiOperations::Segments

data/lib/intercom/service/visitor.rb

@@ -5,7 +5,7 @@ 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/delete'
+require 'intercom/api_operations/archive'
 
 module Intercom
   module Service
@@ -16,7 +16,7 @@ module Intercom
       include ApiOperations::FindAll
       include ApiOperations::Save
       include ApiOperations::Convert
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Visitor

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.6.2"
+  VERSION = "3.7.0"
 end

data/spec/unit/intercom/contact_spec.rb

@@ -50,4 +50,10 @@ describe "Intercom::Contact" do
     client.contacts.delete(contact)
   end
 
+  it "sends a request for a hard deletion" do
+    contact = Intercom::Contact.new("id" => "1")
+    client.expects(:post).with("/user_delete_requests", {intercom_user_id: "1"}).returns({id: contact.id})
+    client.contacts.request_hard_delete(contact)
+  end
+
 end

data/spec/unit/intercom/user_spec.rb

@@ -218,10 +218,22 @@ describe "Intercom::User" do
     client.users.save(user)
   end
 
-  it "deletes a user" do
+  it "archives a user" do
     user = Intercom::User.new("id" => "1")
     client.expects(:delete).with("/users/1", {}).returns(user)
-    client.users.delete(user)
+    client.users.archive(user)
+  end
+   it "has an alias to archive a user" do
+     user = Intercom::User.new("id" => "1")
+     client.expects(:delete).with("/users/1", {}).returns(user)
+     client.users.delete(user)
+   end
+
+
+  it "sends a request for a hard deletion" do
+    user = Intercom::User.new("id" => "1")
+    client.expects(:post).with("/user_delete_requests", {intercom_user_id: "1"}).returns({id: user.id})
+    client.users.request_hard_delete(user)
   end
 
   it "can use client.users.create for convenience" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.7.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-05 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -132,14 +132,15 @@ files:
 - lib/ext/sliceable_hash.rb
 - lib/intercom.rb
 - lib/intercom/admin.rb
+- lib/intercom/api_operations/archive.rb
 - lib/intercom/api_operations/bulk/load_error_feed.rb
 - lib/intercom/api_operations/bulk/submit.rb
 - lib/intercom/api_operations/convert.rb
-- lib/intercom/api_operations/delete.rb
 - lib/intercom/api_operations/find.rb
 - lib/intercom/api_operations/find_all.rb
 - lib/intercom/api_operations/list.rb
 - lib/intercom/api_operations/load.rb
+- lib/intercom/api_operations/request_hard_delete.rb
 - lib/intercom/api_operations/save.rb
 - lib/intercom/api_operations/scroll.rb
 - lib/intercom/client.rb
@@ -229,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API