add an alias for archiving users and contacts and update readme accordingly (#442)

remove delete file

replace calls to delete with archive

Author: theandrewykim

README.md

@@ -68,9 +68,12 @@ user = intercom.users.find(user_id: "1")
 user = intercom.users.find(id: "1")
 # Create a user
 user = intercom.users.create(email: "[email protected]", name: "Bob Smith", signed_up_at: Time.now.to_i)
-# Delete a user
+# archive a user
+user = intercom.users.find(id: "1")	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.delete(user)
+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 +138,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 +201,7 @@ intercom.conversations.find_all(email: '[email protected]', type: 'user', unread:
 intercom.conversations.find_all(email: '[email protected]', 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 +231,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')
 
@@ -417,8 +420,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}

lib/intercom/api_operations/delete.rb lib/intercom/api_operations/archive.rblib/intercom/api_operations/delete.rb renamed to lib/intercom/api_operations/archive.rb

@@ -2,12 +2,14 @@
 
 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

lib/intercom/service/contact.rb

@@ -6,7 +6,7 @@
 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
@@ -19,7 +19,7 @@ class Contact < BaseService
       include ApiOperations::Save
       include ApiOperations::Scroll
       include ApiOperations::Convert
-      include ApiOperations::Delete
+      include ApiOperations::Archive
       include ApiOperations::RequestHardDelete
 
       def collection_class

lib/intercom/service/subscription.rb

@@ -2,7 +2,7 @@
 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 @@ class Subscription < BaseService
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Subscription

lib/intercom/service/tag.rb

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

lib/intercom/service/user.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/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'
@@ -20,7 +20,7 @@ class User < BaseService
       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

lib/intercom/service/visitor.rb

@@ -5,7 +5,7 @@
 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 @@ class Visitor < BaseService
       include ApiOperations::FindAll
       include ApiOperations::Save
       include ApiOperations::Convert
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Visitor

spec/unit/intercom/user_spec.rb

@@ -218,11 +218,17 @@
     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")