Class: Klaviyo::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(api_key, url = 'http://a.klaviyo.com/') ⇒ Client

Returns a new instance of Client.



9
10
11
12
 
# File 'lib/klaviyo/client.rb', line 9

def initialize(api_key, url = 'http://a.klaviyo.com/')
  @api_key = api_key
  @url = url
end

Instance Method Details

#identify(kwargs = {}) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/klaviyo/client.rb', line 44

def identify(kwargs = {})
  defaults = {:id => nil, :email => nil, :properties => {}}
  kwargs = defaults.merge(kwargs)
  
  if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
    raise KlaviyoError.new('You must identify a user by email or ID')
  end
  
  properties = kwargs[:properties]
  properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
  properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?

  params = build_params({
    :token => @api_key,
    :properties => properties
  })
  request('crm/api/identify', params)
end

#track(event, kwargs = {}) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/klaviyo/client.rb', line 14

def track(event, kwargs = {})
  defaults = {:id => nil, :email => nil, :properties => {}, :customer_properties => {}, :time => nil}
  kwargs = defaults.merge(kwargs)
  
  if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
    raise KlaviyoError.new('You must identify a user by email or ID')
  end
  
  customer_properties = kwargs[:customer_properties]
  customer_properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
  customer_properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?

  params = {
    :token => @api_key,
    :event => event,
    :properties => kwargs[:properties],
    :customer_properties => customer_properties,
    :ip => ''
  }
  params[:time] = kwargs[:time].to_time.to_i if kwargs[:time]
 
  params = build_params(params)
  request('crm/api/track', params)
end

#track_once(event, opts = {}) ⇒ Object 



39
40
41
42
 
# File 'lib/klaviyo/client.rb', line 39

def track_once(event, opts = {})
  opts.update('__track_once__' => true)
  track(event, opts)
end