Class: Intercom::User

Inherits:

UserResource

• Object
• UserResource
• Intercom::User

show all

Defined in:

lib/intercom/user.rb

Overview

Class Method Summary (collapse)

• + (UserCollectionProxy) all

  Retrieve all the users Examples:.

• + (Integer) count

  Fetches a count of all Users tracked on Intercom.

• + (User) create(params)

  Creates (or updates when a user already exists for that email/user_id) a user record on your application.

• + (User) delete(params)

  Deletes a user record on your application.

• + (User) find(params)

  Fetches an Intercom::User from our API.

• + (User) find_by_email(email)

  Calls GET api.intercom.io/v1/users?email=EMAIL.

• + (User) find_by_user_id(user_id)

  Calls GET api.intercom.io/v1/users?user_id=USER-ID.

• + (UserCollectionProxy) where(params)

  Retrieve all the users that match a query Examples:.

Instance Method Summary (collapse)

• - (Array) companies

  Multiple companies for this Intercom::User.

• - (Array) companies=(companies)

  Set an Array of Hash company attributes to save/update on this user.

• - (FlatStore) company

  Company stored for this Intercom::User.

• - (FlatStore) company=(company)

  Set a Hash of company attributes to save/update on this user.

• - (Time) created_at

  Get Time at which this User started using your application.

• - (void) created_at=(time)

  Set Time at which this User started using your application.

• - (FlatStore) custom_data

  Custom attributes stored for this Intercom::User.

• - (FlatStore) custom_data=(custom_data)

  Set a Hash of custom data attributes to save/update on this user.

• - (Time) last_impression_at

  Get last time this User interacted with your application.

• - (void) last_impression_at=(time)

  Set Time at which this User last made a request your application.

• - (Time) last_request_at

  Get last time this User interacted with your application.

• - (void) last_request_at=(time)

  Set Time at which this User last made a request your application.

• - (String) last_seen_ip
• - (void) last_seen_ip=(last_seen_ip)
• - (String) last_seen_user_agent
• - (void) last_seen_user_agent=(last_seen_user_agent)
• - (Hash) location_data

  Get hash of location attributes associated with this Intercom::User.

• - (String) name

  The User's name.

• - (void) name=(name)
• - (Integer) relationship_score
• - (User) save

  instance method alternative to #create.

• - (Integer) session_count
• - (Array<SocialProfile>) social_profiles

  Get array of Intercom::SocialProfile objects attached to this Intercom::User.

• - (Boolean) unsubscribed_from_emails

  Get whether user has unsubscribed from email.

• - (void) unsubscribed_from_emails=(unsubscribed_from_emails)

  Set whether user has unsubscribed from email.

Methods inherited from UserResource

#email, #email=, #initialize, #to_hash, #update_from_api_response, #user_id, #user_id=

Methods included from RequiresParameters

#requires_parameters

Methods included from UnixTimestampUnwrapper

#set_time_at, #time_at

Intercom::User.all.each do |user|
  puts user.inspect
end
  > ["user1@example.com" ,"user2@example.com" ,....]
Intercom::User.all.map(&:email)
  > ["user1@example.com" ,"user2@example.com" ,....]

81
82
83

# File 'lib/intercom/user.rb', line 81

def self.all
  UserCollectionProxy.new
end

Intercom::User.all.count
  > 5346

107
108
109
110

# File 'lib/intercom/user.rb', line 107

def self.count
  response = Intercom.get("/v1/users", {:per_page => 1})
  response["total_count"]
end

67
68
69

# File 'lib/intercom/user.rb', line 67

def self.create(params)
  User.new(params).save
end

120
121
122
123

# File 'lib/intercom/user.rb', line 120

def self.delete(params)
  response = Intercom.delete("/v1/users", params)
  User.from_api(response)
end

34
35
36
37

# File 'lib/intercom/user.rb', line 34

def self.find(params)
  response = Intercom.get("/v1/users", params)
  User.from_api(response)
end

45
46
47

# File 'lib/intercom/user.rb', line 45

def self.find_by_email(email)
  find({:email => email})
end

55
56
57

# File 'lib/intercom/user.rb', line 55

def self.find_by_user_id(user_id)
  find({:user_id => user_id})
end

Intercom::User.where(:tag_name => 'Free Trial').each do |user|
  puts user.inspect
end
  > ["user1@example.com" ,"user2@example.com" ,....]
Intercom::User.where(:tag_name => 'Free Trial').map(&:email)
  > ["user1@example.com" ,"user2@example.com" ,....]

97
98
99

# File 'lib/intercom/user.rb', line 97

def self.where(params)
  UserCollectionProxy.new(params)
end

user = Intercom::User.find(:email => "someone@example.com")
user.companies = [{:id => 6, :name => "intercom"}, {:id => 9, :name => "Test Company"}]
user.save

312
313
314

# File 'lib/intercom/user.rb', line 312

def companies
  @attributes["companies"] ||= []
end

320
321
322
323

# File 'lib/intercom/user.rb', line 320

def companies=(companies)
  raise ArgumentError.new("Companies requires an array of hashes of companies") unless companies.is_a?(Array) && companies.all? {|company| company.is_a?(Hash)}
  @attributes["companies"] = companies.collect {|company| FlatStore.new(company) }
end

user = Intercom::User.find(:email => "someone@example.com")
user.company[:id] = 6
user.company[:name] = "Intercom"
user.save

290
291
292

# File 'lib/intercom/user.rb', line 290

def company
  @attributes["company"] ||= FlatStore.new
end

298
299
300

# File 'lib/intercom/user.rb', line 298

def company=(company)
  @attributes["company"] = FlatStore.new(company)
end

204
205
206

# File 'lib/intercom/user.rb', line 204

def created_at
  time_at("created_at")
end

211
212
213

# File 'lib/intercom/user.rb', line 211

def created_at=(time)
  set_time_at("created_at", time)
end

user = Intercom::User.find(:email => "someone@example.com")
puts user.custom_data[:plan]

user = Intercom::User.find(:email => "someone@example.com")
user.custom_data[:plan] = "pro"
user.save

267
268
269

# File 'lib/intercom/user.rb', line 267

def custom_data
  @attributes["custom_data"] ||= FlatStore.new
end

275
276
277

# File 'lib/intercom/user.rb', line 275

def custom_data=(custom_data)
  @attributes["custom_data"] = FlatStore.new(custom_data)
end

176
177
178

# File 'lib/intercom/user.rb', line 176

def last_impression_at
  time_at("last_impression_at")
end

183
184
185

# File 'lib/intercom/user.rb', line 183

def last_impression_at=(time)
  set_time_at("last_impression_at", time)
end

190
191
192

# File 'lib/intercom/user.rb', line 190

def last_request_at
  time_at("last_request_at")
end

197
198
199

# File 'lib/intercom/user.rb', line 197

def last_request_at=(time)
  set_time_at("last_request_at", time)
end

144
145
146

# File 'lib/intercom/user.rb', line 144

def last_seen_ip
  @attributes["last_seen_ip"]
end

149
150
151

# File 'lib/intercom/user.rb', line 149

def last_seen_ip=(last_seen_ip)
  @attributes["last_seen_ip"]=last_seen_ip
end

154
155
156

# File 'lib/intercom/user.rb', line 154

def last_seen_user_agent
  @attributes["last_seen_user_agent"]
end

159
160
161

# File 'lib/intercom/user.rb', line 159

def last_seen_user_agent=(last_seen_user_agent)
  @attributes["last_seen_user_agent"]=last_seen_user_agent
end

{"city_name"=>"Santiago", "continent_code"=>"SA", "country_code"=>"CHL", "country_name"=>"Chile",
 "latitude"=>-33.44999999999999, "longitude"=>-70.6667, "postal_code"=>"", "region_name"=>"12",
 "timezone"=>"Chile/Continental"}

249
250
251

# File 'lib/intercom/user.rb', line 249

def location_data
  @location_data ||= {}.freeze
end

133
134
135

# File 'lib/intercom/user.rb', line 133

def name
  @attributes["name"]
end

139
140
141

# File 'lib/intercom/user.rb', line 139

def name=(name)
  @attributes["name"]=name
end

164
165
166

# File 'lib/intercom/user.rb', line 164

def relationship_score
  @attributes["relationship_score"]
end

127
128
129
130

# File 'lib/intercom/user.rb', line 127

def save
  response = Intercom.post("/v1/users", to_hash)
  self.update_from_api_response(response)
end

169
170
171

# File 'lib/intercom/user.rb', line 169

def session_count
  @attributes["session_count"]
end

234
235
236

# File 'lib/intercom/user.rb', line 234

def social_profiles
  @social_profiles ||= [].freeze
end

218
219
220

# File 'lib/intercom/user.rb', line 218

def unsubscribed_from_emails
  @attributes['unsubscribed_from_emails']
end

225
226
227

# File 'lib/intercom/user.rb', line 225

def unsubscribed_from_emails=(unsubscribed_from_emails)
  @attributes['unsubscribed_from_emails'] = unsubscribed_from_emails
end