klaviyo 2.0.3 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438fe72ddfdd5e636f8026c8e0b02daf22586e58c4a2628065db088b633bb1be
-  data.tar.gz: c586d57114a208aa6843fa6dd218d2e2ceae454282c8b4b297a7ab122cd89dd3
+  metadata.gz: b02aaf0e72a06b6d2bf999e9279a8b6c20c0f4f7652275fea1981ea0ab0683c5
+  data.tar.gz: 4b2ac021105853944c5bdbf47efa268addda7b1006f2683be04cadefb4db7ecc
 SHA512:
-  metadata.gz: bce5653e39bc762647ee52f29a3c0b2d8ea672b782a5192e9ca3d3da11a41e388f67a5c11f7eb28ce7f274f691a445677ee345eb3855ba2fa422ed30407a282f
-  data.tar.gz: 5f831ad7a264a16b697435e1cafe6c942f7c58572bdf67041d74b3f65f398fd4ba948e0c70edbccb6d5839d16f0831553ce2868fe43b6b6fe796d9dfef2e2103
+  metadata.gz: 561d598fa79624b0a2e271efb64676d55f39f09ca4ee787097061006f865f08f14d12faa49da7eea2a28523c3c0d96ed727feff2b40924b3965b1b1b234fb727
+  data.tar.gz: 934fe573a195fa8e307fc1c4383f810965d0b2636e81d8a442ece9c5b613ddef4d3eb3a1d5a159a82328edbb12cd0c87ab071a27ce5d7d57f2e8d7060a29433b

data/klaviyo.gemspec

@@ -2,8 +2,8 @@ files = ['klaviyo.gemspec', '{lib}/**/**/*'].map {|f| Dir[f]}.flatten
 
 Gem::Specification.new do |s|
   s.name        = 'klaviyo'
-  s.version     = '2.0.3'
-  s.date        = '2021-01-11'
+  s.version     = '2.0.8'
+  s.date        = '2021-04-28'
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'
   s.description = 'Ruby wrapper for the Klaviyo API'
   s.authors     = ['Klaviyo Team']

data/lib/klaviyo/apis/data_privacy.rb

@@ -0,0 +1,19 @@
+module Klaviyo
+  class DataPrivacy < Client
+    DATA_PRIVACY = 'data-privacy'
+    DELETION_REQUEST = 'deletion-request'
+
+    # Submits a data privacy-related deletion request
+    # @param id_type [String] 'email' or 'phone_number' or 'person_id
+    # @param identifier [String] value for the identifier specified
+    # @return a dictionary with a confirmation that deletion task submitted for the customer
+    def self.request_profile_deletion(id_type, identifier)
+      unless ['email', 'phone_number', 'person_id'].include? id_type
+        raise Klaviyo::KlaviyoError.new(INVALID_ID_TYPE_ERROR)
+      end
+      data = Hash[id_type.to_sym, identifier]
+      path = "#{DATA_PRIVACY}/#{DELETION_REQUEST}"
+      v2_request(HTTP_POST, path, **data)
+    end
+  end
+end

data/lib/klaviyo/apis/email_templates.rb

@@ -0,0 +1,97 @@
+module Klaviyo
+  class EmailTemplates < Client
+    EMAIL_TEMPLATES = 'email-templates'
+    EMAIL_TEMPLATE = 'email-template'
+    CLONE = 'clone'
+    RENDER = 'render'
+    SEND = 'send'
+
+    # Returns a list of all the email templates you've created.
+    # The templates are returned in sorted order by name.
+    # @return [List] of JSON formatted email template objects
+    def self.get_templates()
+      v1_request(HTTP_GET, EMAIL_TEMPLATES)
+    end
+
+    # Creates a new email template
+    # @param :name [String] The name of the email template
+    # @param :html [String] The HTML content for this template
+    # @return [JSON] a JSON object containing information about the email template
+    def self.create_template(name: nil, html: nil)
+      params = {
+        name: name,
+        html: html
+      }
+      v1_request(HTTP_POST, EMAIL_TEMPLATES, content_type: CONTENT_URL_FORM, params: params)
+    end
+
+    # Updates the name and/or HTML content of a template. Only updates imported
+    # HTML templates; does not currently update drag & drop templates
+    # @param template_id [String] The id of the email template
+    # @param :name [String] The name of the email template
+    # @param :html [String] The HTML content for this template
+    # @return [JSON] a JSON object containing information about the email template
+    def self.update_template(template_id, name:, html:)
+      path = "#{EMAIL_TEMPLATE}/#{template_id}"
+      params = {
+        name: name,
+        html: html
+      }
+      v1_request(HTTP_PUT, path, **params)
+    end
+
+    # Deletes a given template.
+    # @param template_id [String] The id of the email template
+    # @return [JSON] a JSON object containing information about the email template
+    def self.delete_template(template_id)
+      path = "#{EMAIL_TEMPLATE}/#{template_id}"
+      v1_request(HTTP_DELETE, path)
+    end
+
+    # Creates a copy of a given template with a new name
+    # @param template_id [String] The id of the email template to copy
+    # @param :name [String] The name of the newly cloned email template
+    # @return [JSON] a JSON object containing information about the email template
+    def self.clone_template(template_id, name:)
+      path = "#{EMAIL_TEMPLATE}/#{template_id}/#{CLONE}"
+      params = {
+        name: name
+      }
+      v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
+    end
+
+    # Renders the specified template with the provided data and return HTML
+    # and text versions of the email
+    # @param template_id [String] The id of the email template to copy
+    # @param :context [Hash] The context the email template will be rendered with
+    # @return [JSON] a JSON object containing information about the email template
+    def self.render_template(template_id, context: {})
+      path = "#{EMAIL_TEMPLATE}/#{template_id}/#{RENDER}"
+      params = {
+        context: context
+      }
+      v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
+    end
+
+    # Renders the specified template with the provided data and then send the
+    # contents in an email via the service specified
+    # @param template_id [String] The id of the email template to copy
+    # @param :from_email [String] The from email address; used in the reply-to header
+    # @param :from_name [String] The name the email is sent from
+    # @param :subject [String] The subject of the email template
+    # @param :to [Mixed] The email this template is being sent to
+    # @param :context [Hash] The context the email template will be rendered with
+    # @return [JSON] a JSON object containing information about the email template
+    def self.send_template(template_id, from_email:, from_name:, subject:, to:, context: {})
+      path = "#{EMAIL_TEMPLATE}/#{template_id}/#{SEND}"
+      params = {
+        from_email: from_email,
+        from_name: from_name,
+        subject: subject,
+        to: to,
+        context: context
+      }
+      v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
+    end
+  end
+end

data/lib/klaviyo/apis/lists.rb

@@ -14,7 +14,7 @@ module Klaviyo
       body = {
         :list_name => list_name
       }
-      v2_request(HTTP_POST, LISTS, body)
+      v2_request(HTTP_POST, LISTS, **body)
     end
 
     # Retrieves all the lists in the Klaviyo account
@@ -40,7 +40,7 @@ module Klaviyo
       body = {
         :list_name => list_name
       }
-      v2_request(HTTP_PUT, path, body)
+      v2_request(HTTP_PUT, path, **body)
     end
 
     # Deletes a list
@@ -65,7 +65,7 @@ module Klaviyo
         :phone_numbers => phone_numbers,
         :push_tokens => push_tokens
       }
-      v2_request(HTTP_GET, path, params)
+      v2_request(HTTP_GET, path, **params)
     end
 
     # Subscribe profiles to a list.
@@ -80,7 +80,7 @@ module Klaviyo
       params = {
         :profiles => profiles
       }
-      v2_request(HTTP_POST, path, params)
+      v2_request(HTTP_POST, path, **params)
     end
 
     # Unsubscribe and remove profiles from a list
@@ -92,7 +92,7 @@ module Klaviyo
       params = {
         :emails => emails
       }
-      v2_request(HTTP_DELETE, path, params)
+      v2_request(HTTP_DELETE, path, **params)
     end
 
     # Add profiles to a list
@@ -106,7 +106,7 @@ module Klaviyo
       params = {
         :profiles => profiles
       }
-      v2_request(HTTP_POST, path, params)
+      v2_request(HTTP_POST, path, **params)
     end
 
     # Check if profiles are on a list
@@ -123,7 +123,7 @@ module Klaviyo
         :phone_numbers => phone_numbers,
         :push_tokens => push_tokens
       }
-      v2_request(HTTP_GET, path, params)
+      v2_request(HTTP_GET, path, **params)
     end
 
     # Remove profiles from a list
@@ -139,7 +139,7 @@ module Klaviyo
         :phone_numbers => phone_numbers,
         :push_tokens => push_tokens
       }
-      v2_request(HTTP_DELETE, path, params)
+      v2_request(HTTP_DELETE, path, **params)
     end
 
     # Get all emails, phone numbers, along with reasons for list exclusion
@@ -151,7 +151,7 @@ module Klaviyo
       params = {
         :marker => marker
       }
-      v2_request(HTTP_GET, path, params)
+      v2_request(HTTP_GET, path, **params)
     end
 
     # Get all of the emails, phone numbers, and push tokens for profiles in a given list or segment

data/lib/klaviyo/apis/metrics.rb

@@ -1,8 +1,6 @@
 module Klaviyo
   class Metrics < Client
     EXPORT = 'export'
-    METRIC = 'metric'
-    METRICS = 'metrics'
 
     # Returns a list of all metrics in Klaviyo
     # @param page [Integer] which page to return, default 0
@@ -13,7 +11,7 @@ module Klaviyo
         :page => page,
         :count => count
       }
-      v1_request(HTTP_GET, METRICS, params)
+      v1_request(HTTP_GET, METRICS, **params)
     end
 
     # Returns a batched timeline of all events in your Klaviyo account.
@@ -28,7 +26,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
 
     # Returns a batched timeline for one specific type of metric.
@@ -44,7 +42,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
 
     # Export event data, optionally filtering and segmented on available event properties
@@ -76,7 +74,7 @@ module Klaviyo
         :by => by,
         :count => count
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
   end
 end

data/lib/klaviyo/apis/profiles.rb

@@ -1,6 +1,19 @@
 module Klaviyo
   class Profiles < Client
     PERSON = 'person'
+    PEOPLE = 'people'
+    SEARCH = 'search'
+
+    # Retrieves the id of the profile given email
+    # @param email [String] the email of the profile
+    # @return [JSON] a JSON object containing id of the profile
+    def self.get_profile_id_by_email(email)
+      path = "#{PEOPLE}/#{SEARCH}"
+      params = {
+        :email => email
+      }
+      v2_request(HTTP_GET, path, **params)
+    end
 
     # Retrieve all the data attributes for a Klaviyo Person ID.
     # @param person_id [String] the id of the profile
@@ -16,7 +29,7 @@ module Klaviyo
     # @return returns the updated person object
     def self.update_person_attributes(person_id, kwargs = {})
       path = "#{PERSON}/#{person_id}"
-      v1_request(HTTP_PUT, path, kwargs)
+      v1_request(HTTP_PUT, path, **kwargs)
     end
 
     # Listing a person's event timeline
@@ -32,7 +45,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
 
     # Listing a person's event timeline for a particular metric
@@ -49,7 +62,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
   end
 end

data/lib/klaviyo/apis/public.rb

@@ -27,7 +27,7 @@ module Klaviyo
         :properties => properties
       }
 
-      public_request(HTTP_GET, 'identify', params)
+      public_request(HTTP_GET, 'identify', **params)
     end
 
     # Used for tracking events and customer behaviors
@@ -66,9 +66,9 @@ module Klaviyo
         :properties => kwargs[:properties],
         :customer_properties => customer_properties
       }
-      params[:time] = kwargs[:time].to_time.to_i if kwargs[:time]
+      params[:time] = kwargs[:time] if kwargs[:time]
 
-      public_request(HTTP_GET, 'track', params)
+      public_request(HTTP_GET, 'track', **params)
     end
 
     def self.track_once(event, kwargs = {})

data/lib/klaviyo/client.rb

@@ -10,57 +10,76 @@ module Klaviyo
     HTTP_PUT = 'put'
 
     ALL = 'all'
+    METRIC = 'metric'
+    METRICS = 'metrics'
     TIMELINE = 'timeline'
 
     DEFAULT_COUNT = 100
     DEFAULT_PAGE = 0
     DEFAULT_SORT_DESC = 'desc'
 
+    CONTENT_JSON = 'application/json'
+    CONTENT_URL_FORM = 'application/x-www-form-urlencoded'
+
     private
 
-    def self.request(method, path, kwargs = {})
+    def self.request(method, path, content_type, **kwargs)
       check_private_api_key_exists()
       url = "#{BASE_API_URL}/#{path}"
       connection = Faraday.new(
         url: url,
         headers: {
-          'Content-Type' => 'application/json'
+          'Content-Type' => content_type
       })
+      if content_type == CONTENT_JSON
+        kwargs[:body] = kwargs[:body].to_json
+      end
       response = connection.send(method) do |req|
-        req.body = kwargs[:body].to_json || nil
+        req.body = kwargs[:body] || nil
       end
     end
 
-    def self.public_request(method, path, kwargs = {})
+    def self.public_request(method, path, **kwargs)
       check_public_api_key_exists()
       params = build_params(kwargs)
       url = "#{BASE_API_URL}/#{path}?#{params}"
       res = Faraday.get(url).body
     end
 
-    def self.v1_request(method, path, kwargs = {})
-      defaults = {:page => nil,
-                  :count => nil,
-                  :since => nil,
-                  :sort => nil}
-      params = defaults.merge(kwargs)
-      query_params = encode_params(params)
-      full_url = "#{V1_API}/#{path}?api_key=#{Klaviyo.private_api_key}#{query_params}"
-      request(method, full_url)
+    def self.v1_request(method, path, content_type: CONTENT_JSON, **kwargs)
+      if content_type == CONTENT_URL_FORM
+        data = {
+          :body => {
+            :api_key => Klaviyo.private_api_key
+          }
+        }
+        data[:body] = data[:body].merge(kwargs[:params])
+        full_url = "#{V1_API}/#{path}"
+        request(method, full_url, content_type, **data)
+      else
+        defaults = {:page => nil,
+                    :count => nil,
+                    :since => nil,
+                    :sort => nil}
+        params = defaults.merge(kwargs)
+        query_params = encode_params(params)
+        full_url = "#{V1_API}/#{path}?api_key=#{Klaviyo.private_api_key}#{query_params}"
+        request(method, full_url, content_type)
+      end
     end
 
-    def self.v2_request(method, path, kwargs = {})
+    def self.v2_request(method, path, **kwargs)
       path = "#{V2_API}/#{path}"
       key = {
         "api_key": "#{Klaviyo.private_api_key}"
       }
       data = {}
       data[:body] = key.merge(kwargs)
-      request(method, path, data)
+      request(method, path, CONTENT_JSON, **data)
     end
 
     def self.build_params(params)
-      "data=#{Base64.encode64(JSON.generate(params)).gsub(/\n/,'')}"
+      "data=#{CGI.escape(Base64.encode64(JSON.generate(params)).gsub(/\n/, ''))}"
     end
 
     def self.check_required_args(kwargs)

data/lib/klaviyo/klaviyo_module.rb

@@ -9,6 +9,8 @@ require_relative 'apis/lists'
 require_relative 'apis/metrics'
 require_relative 'apis/profiles'
 require_relative 'apis/campaigns'
+require_relative 'apis/email_templates'
+require_relative 'apis/data_privacy'
 
 module Klaviyo
   class << self
@@ -21,4 +23,5 @@ module Klaviyo
   NO_PRIVATE_API_KEY_ERROR = 'Please provide your Private API key for this request'
   NO_PUBLIC_API_KEY_ERROR = 'Please provide your Public API key for this request'
   REQUIRED_ARG_ERROR = 'You must identify a user by email, ID or phone_number'
+  INVALID_ID_TYPE_ERROR = 'Invalid id_type provided, must be one of: email, phone_number, person_id'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.8
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -75,6 +75,8 @@ files:
 - klaviyo.gemspec
 - lib/klaviyo.rb
 - lib/klaviyo/apis/campaigns.rb
+- lib/klaviyo/apis/data_privacy.rb
+- lib/klaviyo/apis/email_templates.rb
 - lib/klaviyo/apis/lists.rb
 - lib/klaviyo/apis/metrics.rb
 - lib/klaviyo/apis/profiles.rb