klaviyo 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28360ee80e88095a3cab7c279740506e843483536659a59b2ac4473e2163e489
-  data.tar.gz: 68e8e4561cdb1790f786b195a83ae3ea557aaf69ff9c7c9356b09cee33f724d6
+  metadata.gz: cd4d1f6230dbb4af41de16e16ed58a2735ac78a214e803077f6ecf1b8a0e84d4
+  data.tar.gz: 2223c93c668ed584cb60d2d48f86073b68dc10056ccf3634754f26e2f8c779fb
 SHA512:
-  metadata.gz: 46def1393ec8838ccfe6c966f0aa0e0651fa3354b6c580a42e764245636aab1e7cc7894d221c405fd23abed2c7bed2ea3a0cc3f1b04841f2ee061538bf5297b0
-  data.tar.gz: 4d5bd8ee0ae050dc333c0b2cf5b3c4be06875a08ea9b6bfa1c3479f755b0d44c255facc7c6cafec76d094714ed74e8bb94ac137fe302b22f29ac12e9477e5bb0
+  metadata.gz: 4708d10212eea6976e6a11051c74e946e30e8b109dfbc204351a9669e3c1fcb77cb29b6e2e6d438bee6c5ee725d330207cd9cbb1e5fb9f75b26835229e6055c5
+  data.tar.gz: 28859dded4559668b1ab44d5e3551369e497351f102aa4bfbc30414cae4c524c683dda22123eaf3a18fff29c3b886b404ee57e900b1190ef71d254844ed90ba6

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.4'
-  s.date        = '2021-04-02'
+  s.version     = '2.0.5'
+  s.date        = '2021-04-05'
   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/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/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

data/lib/klaviyo/apis/profiles.rb

@@ -13,8 +13,7 @@ module Klaviyo
         :email => email
       }
       v2_request(HTTP_GET, path, params)
-    end    
-
+    end
 
     # Retrieve all the data attributes for a Klaviyo Person ID.
     # @param person_id [String] the id of the profile

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,7 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -76,6 +76,7 @@ files:
 - 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