README.md in intercom-3.5.26 vs README.md in intercom-3.6.0

- old
+ new

@@ -20,11 +20,11 @@ gem install intercom Using bundler: - gem 'intercom', '~> 3.5.25' + gem 'intercom', '~> 3.6.0' ## Basic Usage ### Configure your client @@ -130,12 +130,14 @@ company.name = 'Updated company name' intercom.companies.save(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 } -# Get a list of users in a company -intercom.companies.users(company.id) +# 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) # 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 ``` @@ -147,11 +149,11 @@ intercom.tags.untag(name: 'blue', users: [{user_id: "42ea2f1b93891f6a99000427"}]) # Iterate over all tags intercom.tags.all.each {|tag| "#{tag.id} - #{tag.name}" } intercom.tags.all.map {|tag| tag.name } # Tag companies -tag = intercom.tags.tag(name: 'blue', companies: [{id: "42ea2f1b93891f6a99000427"}]) +tag = intercom.tags.tag(name: 'blue', companies: [{company_id: "42ea2f1b93891f6a99000427"}]) ``` #### Segments ```ruby # Find a segment @@ -467,10 +469,10 @@ intercom.rate_limit_details #=> {:limit=>180, :remaining=>179, :reset_at=>2014-10-07 14:58:00 +0100} ``` 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. +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. ``` intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true) ```