Class: Klaviyo::Client
- Inherits:
-
Object
- Object
- Klaviyo::Client
- Defined in:
- lib/klaviyo/client.rb,
lib/klaviyo/client/middleware.rb
Defined Under Namespace
Classes: Middleware
Instance Method Summary collapse
- #identify(kwargs = {}) ⇒ Object
-
#initialize(api_key, env, url = 'http://a.klaviyo.com/') ⇒ Client
constructor
A new instance of Client.
- #track(event, kwargs = {}) ⇒ Object
- #track_once(event, customer_properties = {}, properties = {}) ⇒ Object
Constructor Details
#initialize(api_key, env, url = 'http://a.klaviyo.com/') ⇒ Client
Returns a new instance of Client.
10 11 12 13 14 |
# File 'lib/klaviyo/client.rb', line 10 def initialize(api_key, env, url = 'http://a.klaviyo.com/') @api_key = api_key @env = env @url = url end |
Instance Method Details
#identify(kwargs = {}) ⇒ Object
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/klaviyo/client.rb', line 43 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
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# File 'lib/klaviyo/client.rb', line 16 def track(event, kwargs = {}) defaults = {:id => nil, :email => nil, :properties => {}, :customer_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 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 = build_params({ :token => @api_key, :event => event, :properties => kwargs[:properties], :customer_properties => customer_properties, :ip => '' }) request('crm/api/track', params) end |
#track_once(event, customer_properties = {}, properties = {}) ⇒ Object
38 39 40 41 |
# File 'lib/klaviyo/client.rb', line 38 def track_once(event, customer_properties = {}, properties = {}) properties.update('__track_once__' => true) track(event, email, id, properties, customer_properties) end |