intercom 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebb883bd25fc8d132306baac3a22c43650701dbe42d42b95ada3819bc52cc2d6
-  data.tar.gz: 8d1158c4d79cf19916c6cc1d413c329588d1ff36b5741517e029415e0f992360
+  metadata.gz: d0e11ca3b41ab460f24a33608fb6a4113227bf791cefa9aa9dc9cc31e418faf5
+  data.tar.gz: d0379934e0ab635bb042db6ea4840e930f4c5ad56951554193f7d9ec1e7f190d
 SHA512:
-  metadata.gz: 0a0ea848ac117043da9707f2f9689504abda06f34e218a077c0591216aa654c3e9ca73f9874f2255e7300cd3329c95ba6440232c30d58364877e7d358bf950d0
-  data.tar.gz: 95b5ffdd05e7332fcbd53061c08c380d8632bd9f11d09e3673da65ca25b4624377b409116292b41f626a0fc6b4ad3d1c5183e5315533d3b4f94fe285c74041a6
+  metadata.gz: 7f77ceb73f95a43cfde87e2e274939c76f3dc023d8836683166bdc22f04de9ea14c58cedca3aecffd116023c3f92897c31f5a07d53d0811db1c958109ba5315a
+  data.tar.gz: 6c36c19e9d95c3218b3c4ac5034c252185a1618d62694920ec4fa5576f5152fb5f8eb4634c1cbb3802870195c6f592848269f830eb2060681380e2ba5e68d91c

data/README.md

@@ -1,12 +1,26 @@
 # intercom-ruby
 
-Ruby bindings for the Intercom API (https://developers.intercom.io/reference).
+[![Circle CI](https://circleci.com/gh/intercom/intercom-ruby.png?style=shield)](https://circleci.com/gh/intercom/intercom-ruby)
+[![gem](https://img.shields.io/gem/v/intercom)](https://rubygems.org/gems/intercom)
+![Intercom API Version](https://img.shields.io/badge/Intercom%20API%20Version-2.6-blue)
+
+> Ruby bindings for the [Intercom API](https://developers.intercom.io/reference).
+
+## Project Updates
+
+### Maintenance
+
+We're currently building a new team to provide in-depth and dedicated SDK support.
+
+In the meantime, we'll be operating on limited capacity, meaning all pull requests will be evaluated on a best effort basis and will be limited to critical issues.
+
+We'll communicate all relevant updates as we build this new team and support strategy in the coming months.
 
 [API Documentation](https://developers.intercom.io/docs)
 
 [Gem Documentation](http://rubydoc.info/github/intercom/intercom-ruby/master/frames)
 
-For generating Intercom JavaScript script tags for Rails, please see https://github.com/intercom/intercom-rails.
+For generating Intercom JavaScript script tags for Rails, please see [intercom/intercom-rails](https://github.com/intercom/intercom-rails)
 
 ## Upgrading information
 
@@ -16,12 +30,15 @@ This version of the gem is compatible with `Ruby 2.1` and above.
 
 ## Installation
 
-
-    gem install intercom
+```bash
+gem install intercom
+```
 
 Using bundler:
 
-    gem 'intercom', '~> 4.1'
+```bundler
+gem 'intercom', '~> 4.1'
+```
 
 ## Basic Usage
 
@@ -36,7 +53,7 @@ intercom = Intercom::Client.new(token: 'my_token')
 
 ```ruby
 # With a versioned app:
-intercom = Intercom::Client.new(token: 'my_token', api_version: '2.1')
+intercom = Intercom::Client.new(token: 'my_token', api_version: '2.2')
 ```
 
 If you are building a third party application you can get your access_tokens by [setting-up-oauth](https://developers.intercom.io/page/setting-up-oauth) for Intercom.
@@ -46,29 +63,34 @@ You can also use the [omniauth-intercom lib](https://github.com/intercom/omniaut
 
 Resources this API supports:
 
-    https://api.intercom.io/contacts
-    https://api.intercom.io/visitors
-    https://api.intercom.io/companies
-    https://api.intercom.io/data_attributes
-    https://api.intercom.io/events
-    https://api.intercom.io/tags
-    https://api.intercom.io/notes
-    https://api.intercom.io/segments
-    https://api.intercom.io/conversations
-    https://api.intercom.io/messages
-    https://api.intercom.io/admins
-    https://api.intercom.io/teams
-    https://api.intercom.io/counts
-    https://api.intercom.io/subscriptions
-    https://api.intercom.io/jobs
-    https://api.intercom.io/articles
-    https://api.intercom.io/help_center/collections
-    https://api.intercom.io/help_center/sections
-
+```text
+https://api.intercom.io/contacts
+https://api.intercom.io/visitors
+https://api.intercom.io/companies
+https://api.intercom.io/data_attributes
+https://api.intercom.io/events
+https://api.intercom.io/tags
+https://api.intercom.io/notes
+https://api.intercom.io/segments
+https://api.intercom.io/conversations
+https://api.intercom.io/messages
+https://api.intercom.io/admins
+https://api.intercom.io/teams
+https://api.intercom.io/counts
+https://api.intercom.io/subscriptions
+https://api.intercom.io/jobs
+https://api.intercom.io/articles
+https://api.intercom.io/help_center/collections
+https://api.intercom.io/help_center/sections
+https://api.intercom.io/phone_call_redirects
+https://api.intercom.io/subscription_types
+https://api.intercom.io/export/content/data
+```
 
 ### Examples
 
 #### Contacts
+
 Note that this is a new resource compatible only with the new [Contacts API](https://developers.intercom.com/intercom-api-reference/reference#contacts-model) released in API v2.0.
 
 ```ruby
@@ -95,6 +117,9 @@ intercom.contacts.unarchive(contact)
 # Delete a contact permanently
 intercom.contacts.delete(contact)
 
+# Deletes an archived contact permanently
+intercom.contacts.delete_archived_contact(contact.id)
+
 # List all contacts
 contacts = intercom.contacts.all
 contacts.each { |contact| p contact.name }
@@ -143,9 +168,20 @@ contact.remove_company(id: company.id)
 
 # List companies for a contact
 contact.companies.each {|c| p c.name}
+
+# attach a subscription_types on a contact
+contact.create_subscription_types(id: subscription_type.id)
+
+# List subscription_types for a contact
+contact.subscription_types.each {|n| p n.id}
+
+# Remove subscription_types
+contact.remove_subscription_type({ "id": subscription_type.id })
+
 ```
 
 #### Visitors
+
 ```ruby
 # Get and update a visitor
 visitor = intercom.visitors.find(id: "5dd570e7b1b922452676af23")
@@ -161,6 +197,7 @@ intercom.visitors.convert(visitor, user)
 ```
 
 #### Companies
+
 ```ruby
 # Find a company by company_id
 company = intercom.companies.find(company_id: "44")
@@ -188,7 +225,9 @@ intercom.companies.scroll.each { |comp| puts comp.name}
 ```
 
 #### Data Attributes
+
 Data Attributes are a type of metadata used to describe your customer and company models. These include standard and custom attributes.
+
 ```ruby
 # Create a new custom data attribute
 intercom.data_attributes.create({ name: "test_attribute", model: "contact", data_type: "string" })
@@ -208,10 +247,11 @@ intercom.data_attributes.save(attribute)
 
 # Find all customer attributes including archived
 customer_attributes_incl_archived = intercom.data_attributes.find_all({"model": "contact", "include_archived": true})
-customer_attributes_incl_archived.each { |attr| p attribute.name }
+customer_attributes_incl_archived.each { |attr| p attr.name }
 ```
 
 #### Events
+
 ```ruby
 intercom.events.create(
   event_name: "invited-friend",
@@ -233,6 +273,14 @@ intercom.events.create(
 
 # Retrieve event list for user with id:'123abc'
  intercom.events.find_all("type" => "user", "intercom_user_id" => "123abc")
+
+# Retrieve the event summary for user with id: 'abc' this will return an event object with the following characteristics:
+# name - name of the event
+# first - time when event first occured.
+# last - time when event last occured
+# count - number of times the event occured
+# description -  description of the event
+ events = intercom.events.find_all(type: 'user',intercom_user_id: 'abc',summary: true)
 ```
 
 Metadata Objects support a few simple types that Intercom can present on your behalf
@@ -257,7 +305,8 @@ intercom.events.create(
 )
 ```
 
-The metadata key values in the example are treated as follows-
+The metadata key values in the example are treated as follows:
+
 - order_date: a Date (key ends with '_date')
 - stripe_invoice: The identifier of the Stripe invoice (has a 'stripe_invoice' key)
 - order_number: a Rich Link (value contains 'url' and 'value' keys)
@@ -266,6 +315,7 @@ The metadata key values in the example are treated as follows-
 *NB:* This version of the gem reserves the field name `type` in Event data.
 
 #### Tags
+
 ```ruby
 # Iterate over all tags
 intercom.tags.all.each {|tag| "#{tag.id} - #{tag.name}" }
@@ -276,15 +326,24 @@ tag = intercom.tags.tag(name: 'blue', companies: [{company_id: "42ea2f1b93891f6a
 
 # Untag Companies
 tag = intercom.tags.untag(name: 'blue', companies: [{ company_id: "42ea2f1b93891f6a99000427" }])
+
+
+# Delete Tags
+
+# Note : If there any depedent objects for the tag we are trying to delete, then an error TagHasDependentObjects will be thrown.
+tag = intercom.tags.find(id:"123")
+intercom.tags.delete(tag)
 ```
 
 #### Notes
+
 ```ruby
 # Find a note by id
 note = intercom.notes.find(id: "123")
 ```
 
 #### Segments
+
 ```ruby
 # Find a segment
 segment = intercom.segments.find(id: segment_id)
@@ -294,10 +353,13 @@ intercom.segments.all.each {|segment| puts "id: #{segment.id} name: #{segment.na
 ```
 
 #### Conversations
+
 ```ruby
 # Iterate over all conversations for your app
 intercom.conversations.all.each { |convo| ... }
 
+# The below method of finding conversations by using the find_all method work only for API versions 2.5 and below
+
 # FINDING CONVERSATIONS FOR AN ADMIN
 # Iterate over all conversations (open and closed) assigned to an admin
 intercom.conversations.find_all(type: 'admin', id: '7').each {|convo| ... }
@@ -424,6 +486,7 @@ conversation.remove_contact(id: contact.id, admin_id: admin.id)
 ```
 
 #### Full loading of an embedded entity
+
 ```ruby
 # Given a conversation with a partial contact, load the full contact. This can be
 # done for any entity
@@ -431,6 +494,7 @@ intercom.contacts.load(conversation.contacts.first)
 ```
 
 #### Sending messages
+
 ```ruby
 
 # InApp message from admin to user
@@ -494,9 +558,20 @@ intercom.messages.create({
   },
   body: "halp"
 })
+
+#From version 2.6 the type contact is not supported and you would have to use leads to send messages to a lead.
+
+intercom.messages.create({
+  from: {
+    type: "lead",
+    id: "536e5643as316c83104c400671"
+  },
+  body: "halp"
+})
 ```
 
 #### Admins
+
 ```ruby
 # Find access token owner (only with Personal Access Token and OAuth)
 intercom.admins.me
@@ -507,6 +582,7 @@ intercom.admins.all.each {|admin| puts admin.email }
 ```
 
 #### Teams
+
 ```ruby
 # Find a team by id
 intercom.teams.find(id: team_id)
@@ -543,7 +619,21 @@ intercom.subscriptions.delete(subscription)
 intercom.subscriptions.all
 ```
 
+
+#### Subscription Types
+
+List all the subscription types that a contact can opt in to
+
+```ruby
+
+# fetch a subscription
+intercom.subscription_types.find(id: "1")
+
+intercom.subscription_types.all
+```
+
 #### Articles
+
 ```ruby
 # Create an article
 article = intercom.articles.create(title: "New Article", author_id: "123456")
@@ -577,6 +667,7 @@ intercom.articles.delete(article)
 ```
 
 #### Collections
+
 ```ruby
 # Create a collection
 collection = intercom.collections.create(name: "New Collection")
@@ -609,6 +700,7 @@ intercom.collections.delete(collection)
 ```
 
 #### Sections
+
 ```ruby
 # Create a section
 section = intercom.sections.create(name: "New Section", parent_id: "123456")
@@ -640,6 +732,29 @@ intercom.collections.save(section)
 intercom.sections.delete(section)
 ```
 
+#### Phone Call Redirect (switch)
+
+```ruby
+# Create a redirect
+redirect = intercom.phone_call_redirect.create(phone_number: "+353871234567")
+
+```
+
+#### Data Content Export
+
+```ruby
+# Create a data export
+export = intercom.export_content.create(created_at_after: 1667566801, created_at_before: 1668085202)
+
+
+#View a data export
+export = intercom.export_content.find(id: 'k0e27ohsyvh8ef3m')
+
+# Cancel a data export
+export = intercom.export_content.cancel('k0e27ohsyvh8ef3m')
+
+```
+
 ### Errors
 
 There are different styles for error handling - some people prefer exceptions; some prefer nil and check; some prefer error objects/codes. Balancing these preferences alongside our wish to provide an idiomatic gem has brought us to use the current mechanism of throwing specific exceptions. Our approach in the client is to propagate errors and signal our failure loudly so that erroneous data does not get propagated through our customers' systems - in other words, if you see a `Intercom::ServiceUnavailableError` you know where the problem is.
@@ -660,6 +775,7 @@ Intercom::RateLimitExceeded
 Intercom::AttributeNotSetError # Raised when you try to call a getter that does not exist on an object
 Intercom::MultipleMatchingUsersError
 Intercom::HttpError # Raised when response object is unexpectedly nil
+Intercom::GatewayTimeoutError
 ```
 
 ### Rate Limiting
@@ -674,7 +790,7 @@ intercom.rate_limit_details
 You can handle the rate limits yourself but a simple option is to use the handle_rate_limit flag.
 This will automatically catch the 429 rate limit exceeded error and wait until the reset time to retry. After three retries a rate limit exception will be raised. Encountering this error frequently may require a revisiting of your usage of the API.
 
-```
+```ruby
 intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true)
 ```
 
@@ -700,13 +816,13 @@ intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true)
 
 ```bash
 # all tests
-bundle exec spec
+bundle exec rake spec
 
 # unit tests
-bundle exec spec:unit
+bundle exec rake spec:unit
 
 # integration tests
-bundle exec spec:integration
+bundle exec rake spec:integration
 
 # single test file
 bundle exec m spec/unit/intercom/job_spec.rb

data/changes.txt

@@ -1,3 +1,15 @@
+4.1.3
+- Updated ReadMe with more errors.
+- Fixed issue where paginated requests could only be iterated through once.
+- Moved Dynamic accessors from class level to instance level.
+
+4.1.2
+- Adding support for company delete.
+- Adding support for archiving/unarchiving contacts.
+- Adding support for listing contact segments.
+- Fixed issue with scroll collection proxy.
+- Fixed issue with running assignment rules on a conversation.
+
 4.1.1
 - Fixed bug with deprecated lead resource.
 

data/lib/intercom/api_operations/nested_resource.rb

@@ -13,9 +13,7 @@ module Intercom
           raise ArgumentError, 'operations array required' if operations.nil?
 
           resource_url_method = :"#{resource_plural}_url"
-
           resource_name = Utils.resource_class_to_collection_name(self)
-
           define_method(resource_url_method.to_sym) do |id, nested_id = nil|
             url = "/#{resource_name}/#{id}/#{path}"
             url += "/#{nested_id}" unless nested_id.nil?

data/lib/intercom/base_collection_proxy.rb

@@ -45,7 +45,11 @@ module Intercom
                                Utils.entity_key_from_type(top_level_type)
                              end
       response_hash[top_level_entity_key].each do |object_json|
-        block.call Lib::TypedJsonDeserializer.new(object_json, @client).deserialize
+        if top_level_type == 'event.summary'
+          block.call Lib::TypedJsonDeserializer.new(object_json, @client, top_level_type).deserialize
+        else
+          block.call Lib::TypedJsonDeserializer.new(object_json, @client).deserialize
+        end
       end
     end
 
@@ -58,6 +62,7 @@ module Intercom
         @params[:starting_after] = paging_next['starting_after']
         return true
       else
+        @params[:starting_after] = nil
         return false
       end
     end

data/lib/intercom/client.rb

@@ -84,6 +84,10 @@ module Intercom
       Intercom::Service::Subscription.new(self)
     end
 
+    def subscription_types
+      Intercom::Service::SubscriptionType.new(self)
+    end
+
     def segments
       Intercom::Service::Segment.new(self)
     end
@@ -124,6 +128,14 @@ module Intercom
       Intercom::Service::Collection.new(self)
     end
 
+    def export_content
+      Intercom::Service::ExportContent.new(self)
+    end
+
+    def phone_call_redirect
+      Intercom::Service::PhoneCallRedirect.new(self)
+    end
+
     def get(path, params)
       execute_request Intercom::Request.get(path, params)
     end

data/lib/intercom/contact.rb

@@ -12,6 +12,7 @@ module Intercom
 
     nested_resource_methods :tag, operations: %i[add delete list]
     nested_resource_methods :note, operations: %i[create list]
+    nested_resource_methods :subscription_type, path: 'subscriptions', operations: %i[create delete list]
     nested_resource_methods :company, operations: %i[add delete list]
     nested_resource_methods :segment, operations: %i[list]
 

data/lib/intercom/errors.rb

@@ -99,6 +99,9 @@ module Intercom
   # Raised when a merge is invalid
   class InvalidMergeError < IntercomError; end
 
+  # Raised when a tag has dependent objects
+  class TagHasDependentObjects < IntercomError; end
+
   #
   # Non-public errors (internal to the gem)
   #

data/lib/intercom/export_content.rb

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

data/lib/intercom/lib/dynamic_accessors.rb

@@ -5,20 +5,19 @@ module Intercom
       class << self
 
         def define_accessors(attribute, value, object)
-          klass = object.class
           if attribute.to_s.end_with?('_at') && attribute.to_s != 'update_last_request_at'
-            define_date_based_accessors(attribute, value, klass)
+            define_date_based_accessors(attribute, value, object)
           elsif object.flat_store_attribute?(attribute)
-            define_flat_store_based_accessors(attribute, value, klass)
+            define_flat_store_based_accessors(attribute, value, object)
           else
-            define_standard_accessors(attribute, value, klass)
+            define_standard_accessors(attribute, value, object)
           end
         end
 
         private
 
-        def define_flat_store_based_accessors(attribute, value, klass)
-          klass.class_eval %Q"
+        def define_flat_store_based_accessors(attribute, value, object)
+          object.instance_eval %Q"
             def #{attribute}=(value)
               mark_field_as_changed!(:#{attribute})
               @#{attribute} = Intercom::Lib::FlatStore.new(value)
@@ -29,8 +28,8 @@ module Intercom
           "
         end
 
-        def define_date_based_accessors(attribute, value, klass)
-          klass.class_eval %Q"
+        def define_date_based_accessors(attribute, value, object)
+          object.instance_eval %Q"
             def #{attribute}=(value)
               mark_field_as_changed!(:#{attribute})
               @#{attribute} = value.nil? ? nil : value.to_i
@@ -41,8 +40,8 @@ module Intercom
           "
         end
 
-        def define_standard_accessors(attribute, value, klass)
-            klass.class_eval %Q"
+        def define_standard_accessors(attribute, value, object)
+            object.instance_eval %Q"
               def #{attribute}=(value)
                 mark_field_as_changed!(:#{attribute})
                 @#{attribute} = value

data/lib/intercom/lib/typed_json_deserializer.rb

@@ -9,9 +9,10 @@ module Intercom
     class TypedJsonDeserializer
       attr_reader :json
 
-      def initialize(json, client)
+      def initialize(json, client, type = nil)
         @json = json
         @client = client
+        @type = type
       end
 
       def deserialize
@@ -27,7 +28,7 @@ module Intercom
       private
 
       def blank_object_type?(object_type)
-        object_type.nil? || object_type == ''
+        object_type.nil? || object_type == '' && @type.nil?
       end
 
       def list_object_type?(object_type)
@@ -48,7 +49,11 @@ module Intercom
       end
 
       def object_type
-        @object_type ||= json['type']
+        if !@type.nil?
+          @object_type = @type
+        else
+          @object_type ||= json['type'] 
+        end
       end
 
       def object_entity_key

data/lib/intercom/phone_call_redirect.rb

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

data/lib/intercom/request.rb

@@ -222,6 +222,8 @@ module Intercom
         raise Intercom::ApiVersionInvalid.new(error_details['message'], error_context)
       when 'scroll_exists'
         raise Intercom::ScrollAlreadyExistsError.new(error_details['message'], error_context)
+      when 'tag_has_dependent_objects'
+        raise Intercom::TagHasDependentObjects.new(error_details['message'], error_context)
       when nil, ''
         raise Intercom::UnexpectedError.new(message_for_unexpected_error_without_type(error_details, parsed_http_code), error_context)
       else

data/lib/intercom/service/contact.rb

@@ -43,6 +43,10 @@ module Intercom
         contact
       end
 
+      def delete_archived_contact(id)
+        @client.delete("/#{collection_name}/#{id}", {})
+      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

@@ -21,6 +21,10 @@ module Intercom
         Intercom::Conversation
       end
 
+      def collection_proxy_class
+        Intercom::BaseCollectionProxy
+      end
+
       def mark_read(id)
         @client.put("/conversations/#{id}", read: true)
       end

data/lib/intercom/service/export_content.rb

@@ -0,0 +1,30 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/save'
+
+module Intercom
+  module Service
+    class ExportContent < BaseService
+      include ApiOperations::Load
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::Save
+
+      def collection_class
+        Intercom::ExportContent
+      end
+
+      def collection_name
+        'export/content/data'
+      end
+
+      def cancel(id)
+        response = @client.post("/export/cancel/#{id}", {})
+        collection_class.new.from_response(response)
+      end
+
+    end
+  end
+end
+

data/lib/intercom/service/phone_call_redirect.rb

@@ -0,0 +1,15 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/save'
+
+module Intercom
+  module Service
+    class PhoneCallRedirect < BaseService
+      include ApiOperations::Save
+
+      def collection_class
+        Intercom::PhoneCallRedirect
+      end
+
+    end
+  end
+end

data/lib/intercom/service/subscription_type.rb

@@ -0,0 +1,18 @@
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/find'
+
+module Intercom
+  module Service
+    class SubscriptionType < BaseService
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::FindAll
+      include ApiOperations::Delete
+
+      def collection_class
+        Intercom::SubscriptionType
+      end
+    end
+  end
+end

data/lib/intercom/subscription_type.rb

@@ -0,0 +1,12 @@
+
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class SubscriptionType
+    include Traits::ApiResource
+
+    def self.collection_proxy_class
+      Intercom::BaseCollectionProxy
+    end
+  end
+end

data/lib/intercom/utils.rb

@@ -25,6 +25,10 @@ module Intercom
         constant
       end
 
+      def camelize(snake_cased_word)
+        snake_cased_word.split(/_/).map(&:capitalize).join
+      end
+
       def resource_class_to_singular_name(resource_class)
         resource_name = resource_class.to_s.split('::')[-1]
         resource_name = maybe_underscore_name(resource_name)
@@ -40,7 +44,7 @@ module Intercom
       end
 
       def constantize_resource_name(resource_name)
-        class_name = Utils.singularize(resource_name.capitalize)
+        class_name = camelize Utils.singularize(resource_name.capitalize)
         define_lightweight_class(class_name) unless Intercom.const_defined?(class_name, false)
         namespaced_class_name = "Intercom::#{class_name}"
         constantize namespaced_class_name
@@ -65,6 +69,7 @@ module Intercom
 
         is_list = type.split('.')[1] == 'list'
         entity_name = type.split('.')[0]
+        return Utils.pluralize(entity_name) if entity_name == 'event'
         is_list ? Utils.pluralize(entity_name) : entity_name
       end
     end

data/lib/intercom/version.rb

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

data/lib/intercom.rb

@@ -12,6 +12,7 @@ require 'intercom/service/event'
 require 'intercom/service/message'
 require 'intercom/service/note'
 require 'intercom/service/job'
+require 'intercom/service/subscription_type'
 require 'intercom/service/subscription'
 require 'intercom/service/segment'
 require 'intercom/service/section'
@@ -21,6 +22,8 @@ require 'intercom/service/visitor'
 require 'intercom/service/user'
 require 'intercom/service/lead'
 require 'intercom/deprecated_resources.rb'
+require 'intercom/service/export_content'
+require 'intercom/service/phone_call_redirect'
 require 'intercom/options'
 require 'intercom/client'
 require 'intercom/contact'
@@ -42,10 +45,13 @@ require 'intercom/admin'
 require 'intercom/article'
 require 'intercom/request'
 require 'intercom/subscription'
+require 'intercom/subscription_type'
 require 'intercom/team'
 require 'intercom/errors'
 require 'intercom/visitor'
 require 'intercom/data_attribute'
+require 'intercom/export_content'
+require 'intercom/phone_call_redirect'
 require 'json'
 
 ##

data/spec/unit/intercom/base_collection_proxy_spec.rb

@@ -4,7 +4,7 @@ describe Intercom::BaseCollectionProxy do
   let(:client) { Intercom::Client.new(token: 'token') }
 
   it "stops iterating if no starting after value" do
-    client.expects(:get).with("/contacts", {}). returns(page_of_contacts(false))
+    client.expects(:get).with("/contacts", {}).returns(page_of_contacts(false))
     emails = []
     client.contacts.all.each { |contact| emails << contact.email }
     _(emails).must_equal %w[test1@example.com test2@example.com test3@example.com]
@@ -15,6 +15,7 @@ describe Intercom::BaseCollectionProxy do
     client.expects(:get).with('/contacts', { starting_after: "EnCrYpTeDsTrInG" }).returns(page_of_contacts(false))
     emails = []
     client.contacts.all.each { |contact| emails << contact.email }
+    _(emails).must_equal %w[test1@example.com test2@example.com test3@example.com test1@example.com test2@example.com test3@example.com]
   end
 
   it "supports indexed array access" do
@@ -27,4 +28,20 @@ describe Intercom::BaseCollectionProxy do
     emails = client.contacts.all.map { |contact| contact.email }
     _(emails).must_equal %w[test1@example.com test2@example.com test3@example.com]
   end
+
+  it "keeps entire collection iterable after first iteration" do
+    contacts = client.contacts.all
+    emails_iter1 = []
+    emails_iter2 = []
+    expects_pagination = proc do
+      client.expects(:get).with("/contacts", {}).returns(page_of_contacts(true))
+      client.expects(:get).with("/contacts", { starting_after: "EnCrYpTeDsTrInG" }).returns(page_of_contacts(false))
+    end
+
+    expects_pagination.call
+    contacts.each { |contact| emails_iter1 << contact.email }
+    expects_pagination.call
+    contacts.each { |contact| emails_iter2 << contact.email }
+    _(emails_iter1).must_equal emails_iter2
+  end
 end

data/spec/unit/intercom/contact_spec.rb

@@ -260,6 +260,12 @@ describe Intercom::Contact do
     client.contacts.unarchive(contact)
   end
 
+  it 'deletes an archived contact' do
+    contact = Intercom::Contact.new('id' => '1','archived' =>true)
+    client.expects(:delete).with('/contacts/1', {})
+    client.contacts.delete_archived_contact("1")
+  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') }
@@ -274,7 +280,9 @@ describe Intercom::Contact do
 
   describe 'nested resources' do
     let(:contact) { Intercom::Contact.new(id: '1', client: client) }
+    let(:contact_no_tags) { Intercom::Contact.new(id: '2', client: client, tags: []) }
     let(:company) { Intercom::Company.new(id: '1') }
+    let(:subscription) { Intercom::Subscription.new(id: '1', client: client) }
     let(:tag) { Intercom::Tag.new(id: '1') }
     let(:note) { Intercom::Note.new(body: "<p>Text for the note</p>") }
 
@@ -299,6 +307,27 @@ describe Intercom::Contact do
       _(proxy.resource_class).must_equal Intercom::Tag
     end
 
+    it 'returns correct tags from differring contacts' do
+      client.expects(:get).with('/contacts/1/tags', {}).returns({
+        'type' => 'tag.list',
+        'tags' => [
+          {
+            'type' => 'tag',
+            'id' => '1',
+            'name' => 'VIP Customer'
+          },
+          {
+            'type' => 'tag',
+            'id' => '2',
+            'name' => 'Test tag'
+          }
+        ]
+      })
+
+      _(contact_no_tags.tags.map{ |t| t.id }).must_equal []
+      _(contact.tags.map{ |t| t.id }).must_equal ['1', '2']
+    end
+
     it 'returns a collection proxy for listing companies' do
       proxy = contact.companies
       _(proxy.resource_name).must_equal 'companies'
@@ -316,6 +345,11 @@ describe Intercom::Contact do
       contact.add_tag({ "id": tag.id })
     end
 
+    it 'removes a subscription to a contact' do
+      client.expects(:delete).with("/contacts/1/subscriptions/#{subscription.id}", "id": subscription.id).returns(subscription.to_hash)
+      contact.remove_subscription_type({ "id": subscription.id })
+    end
+
     it 'removes a tag from a contact' do
       client.expects(:delete).with("/contacts/1/tags/#{tag.id}", "id": tag.id ).returns(tag.to_hash)
       contact.remove_tag({ "id": tag.id })
@@ -365,6 +399,11 @@ describe Intercom::Contact do
         contact.create_note({body: note.body})
       end
 
+      it 'adds a subscription to a contact' do
+        client.expects(:post).with('/contacts/1/subscriptions', "id": subscription.id).returns(subscription.to_hash)
+        contact.create_subscription_type({ "id": subscription.id })
+      end
+
       it 'adds a tag to a contact' do
         client.expects(:post).with('/contacts/1/tags', "id": tag.id).returns(tag.to_hash)
         contact.add_tag({ "id": tag.id })

data/spec/unit/intercom/event_spec.rb

@@ -22,6 +22,13 @@ describe "Intercom::Event" do
     _(event_names).must_equal %W(invited-friend)
   end
 
+  it "able to fetch event summary" do
+    client.expects(:get).with("/events", type: 'user', email: 'joe@example.com', summary: true).returns(page_of_events(false))
+    event_names = []
+    client.events.find_all(type: 'user', email: 'joe@example.com',summary: true).each { |event| event_names << event.event_name }
+    _(event_names).must_equal %W(invited-friend)
+  end
+
   it "keeps iterating if next link" do
     client.expects(:get).with("/events", type: 'user', email: 'joe@example.com').returns(page_of_events(true))
     client.expects(:get).with("https://api.intercom.io/events?type=user&intercom_user_id=55a3b&before=144474756550", {}).returns(page_of_events(false))

data/spec/unit/intercom/export_content_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "Intercom::ExportContent" do
+  let(:client) { Intercom::Client.new(token: 'token') }
+  let(:job) {
+    {
+      job_identifier: "k0e27ohsyvh8ef3m",
+      status: "no_data",
+      download_url: "",
+      download_expires_at: 0
+    }
+  }
+
+  it "creates an export job" do
+    client.expects(:post).with("/export/content/data", {"created_at_after" => 1667566801, "created_at_before" => 1668085202}).returns(job)
+    client.export_content.create({"created_at_after" => 1667566801, "created_at_before" => 1668085202})
+  end
+
+  it "can view an export job" do
+    client.expects(:get).with("/export/content/data/#{job[:job_identifier]}", {}).returns(job)
+    client.export_content.find(id: job[:job_identifier])
+  end
+
+  it "Cancels a export job redirect" do
+    client.expects(:post).with("/export/cancel/#{job[:job_identifier]}", {}).returns(job)
+    client.export_content.cancel(job[:job_identifier])
+  end
+end

data/spec/unit/intercom/phone_call_redirect.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "Intercom::PhoneCallRedirect" do
+  let(:client) { Intercom::Client.new(token: 'token') }
+
+  it "creates a phone redirect" do
+    
+    client.expects(:post).with("/phone_call_redirect", {phone_number: "+353871234567"})
+    client.phone_call_redirect.create(phone_number: "+353871234567")
+  end
+
+end

data/spec/unit/intercom/request_spec.rb

@@ -124,6 +124,9 @@ describe 'Intercom::Request', '#execute' do
     let(:uri) {"https://api.intercom.io/conversations/reply"}
     let(:req) { Intercom::Request.put(uri, {}) }
 
+    let(:tag_uri) {"https://api.intercom.io/tags/"}
+    let(:del_req) { Intercom::Request.delete(tag_uri, {}) }
+
     it 'should raise ResourceNotUniqueError error on resource_conflict code' do
       stub_request(:put, uri).to_return(
         status: [409, "Resource Already Exists"],
@@ -153,5 +156,15 @@ describe 'Intercom::Request', '#execute' do
 
       expect { execute! }.must_raise(Intercom::ResourceNotFound)
     end
+
+    it 'should raise TagHasDependentObjects error on tag_has_dependent_objects code' do
+      stub_request(:delete, tag_uri).to_return(
+        status: [400, "Bad Request"],
+        headers: { 'X-RateLimit-Reset' => (Time.now.utc + 10).to_i.to_s },
+        body: { type: "error.list", errors: [ code: "tag_has_dependent_objects" ] }.to_json
+      )
+
+      expect { del_req.execute(tag_uri, token: 'test-token') }.must_raise(Intercom::TagHasDependentObjects)
+    end
   end
 end

data/spec/unit/intercom/tag_spec.rb

@@ -28,4 +28,10 @@ describe 'Intercom::Tag' do
     client.expects(:post).with('/tags', 'name' => 'Test Tag', 'companies' => [{ company_id: 'abc123', untag: true }, { company_id: 'def456', untag: true }], 'tag_or_untag' => 'untag').returns(test_tag)
     client.tags.untag(name: 'Test Tag', companies: [{ company_id: 'abc123' }, { company_id: 'def456' }])
   end
+
+  it 'delete tags' do
+    tag = Intercom::Tag.new('id' => '1')
+    client.expects(:delete).with('/tags/1', {}).returns(tag)
+    client.tags.delete(tag)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -174,6 +174,7 @@ files:
 - lib/intercom/deprecated_resources.rb
 - lib/intercom/errors.rb
 - lib/intercom/event.rb
+- lib/intercom/export_content.rb
 - lib/intercom/extended_api_operations/segments.rb
 - lib/intercom/extended_api_operations/tags.rb
 - lib/intercom/job.rb
@@ -185,6 +186,7 @@ files:
 - lib/intercom/message.rb
 - lib/intercom/note.rb
 - lib/intercom/options.rb
+- lib/intercom/phone_call_redirect.rb
 - lib/intercom/request.rb
 - lib/intercom/scroll_collection_proxy.rb
 - lib/intercom/search_collection_proxy.rb
@@ -200,18 +202,22 @@ files:
 - lib/intercom/service/count.rb
 - lib/intercom/service/data_attribute.rb
 - lib/intercom/service/event.rb
+- lib/intercom/service/export_content.rb
 - lib/intercom/service/job.rb
 - lib/intercom/service/lead.rb
 - lib/intercom/service/message.rb
 - lib/intercom/service/note.rb
+- lib/intercom/service/phone_call_redirect.rb
 - lib/intercom/service/section.rb
 - lib/intercom/service/segment.rb
 - lib/intercom/service/subscription.rb
+- lib/intercom/service/subscription_type.rb
 - lib/intercom/service/tag.rb
 - lib/intercom/service/team.rb
 - lib/intercom/service/user.rb
 - lib/intercom/service/visitor.rb
 - lib/intercom/subscription.rb
+- lib/intercom/subscription_type.rb
 - lib/intercom/tag.rb
 - lib/intercom/team.rb
 - lib/intercom/traits/api_resource.rb
@@ -235,11 +241,13 @@ files:
 - spec/unit/intercom/data_attribute_spec.rb
 - spec/unit/intercom/deprecated_leads_collection_proxy_spec.rb
 - spec/unit/intercom/event_spec.rb
+- spec/unit/intercom/export_content_spec.rb
 - spec/unit/intercom/job_spec.rb
 - spec/unit/intercom/lead_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
+- spec/unit/intercom/phone_call_redirect.rb
 - spec/unit/intercom/request_spec.rb
 - spec/unit/intercom/scroll_collection_proxy_spec.rb
 - spec/unit/intercom/search_collection_proxy_spec.rb
@@ -271,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby bindings for the Intercom API
@@ -290,11 +298,13 @@ test_files:
 - spec/unit/intercom/data_attribute_spec.rb
 - spec/unit/intercom/deprecated_leads_collection_proxy_spec.rb
 - spec/unit/intercom/event_spec.rb
+- spec/unit/intercom/export_content_spec.rb
 - spec/unit/intercom/job_spec.rb
 - spec/unit/intercom/lead_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
+- spec/unit/intercom/phone_call_redirect.rb
 - spec/unit/intercom/request_spec.rb
 - spec/unit/intercom/scroll_collection_proxy_spec.rb
 - spec/unit/intercom/search_collection_proxy_spec.rb