klaviyo 2.0.1 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a6eaa11bdc826d37a755546d9cb771a469ff9039
-  data.tar.gz: 9f599d1c47bc281311a8adeb5f0c90e8467e4b65
+SHA256:
+  metadata.gz: c50780aa07007d13ffcbfd5e88692dc46122641627511be21f4988012d48d20e
+  data.tar.gz: 453757a911094db7394000a2aa59d4a0f31a3cb6aa9196e50a749dac3e51b336
 SHA512:
-  metadata.gz: 9a9ddabcb4a51a640a3f6b265d329a77934a5146803a4e4c67482fe4fbb7589e8dc722c193c55a7ae547ef917da6a61ad44e666442f7107f0963affdb8af7166
-  data.tar.gz: a04c3224f53c41f732e99f423b0e0e895772b3edd87b2824b179aec24f14c258f12f541631d035550fab32241f43558d04dd92b159fb9145e83d76737ee36d5b
+  metadata.gz: 62278b5560afe418dc8658e71646f36905cdb10c2b607b923377ea08c8ea247630fc782c6dbceda1d4fe2a88f5f332995abce6dcf90484cfbc1791516d4b6cd3
+  data.tar.gz: 1358f2f45b1e92144f8a43f0f52a291f3ee859af3e416924e003a1b7c7a02553965d6240fecf8289eb41167c422565c8909b57344b8baed9091c6f022801183b

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.1'
-  s.date        = '2020-11-23'
+  s.version     = '2.0.6'
+  s.date        = '2021-04-08'
   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/campaigns.rb

@@ -0,0 +1,41 @@
+module Klaviyo
+  class Campaigns < Client
+    CANCEL = 'cancel'
+    CAMPAIGN = 'campaign'
+    CAMPAIGNS = 'campaigns'
+    SEND = 'send'
+
+     # Retrieves all the campaigns from Klaviyo account
+     # @return [List] of JSON formatted campaing objects
+    def self.get_campaigns()
+      v1_request(HTTP_GET, CAMPAIGNS)
+    end
+
+    # Retrieves the details of the list
+    # @param campaign_id the if of campaign
+    # @return [JSON] a JSON object containing information about the campaign
+    def self.get_campaign_details(campaign_id)
+      path = "#{CAMPAIGN}/#{campaign_id}"
+
+      v1_request(HTTP_GET, path)
+    end
+
+    # Sends the campaign immediately
+    # @param campaign_id [String] the id of campaign
+    # @return will return with HTTP ok in case of success
+    def self.send_campaign(campaign_id)
+      path = "#{CAMPAIGN}/#{campaign_id}/#{SEND}"
+
+      v1_request(HTTP_POST, path)
+    end
+
+    # Cancels the campaign with specified campaign_id
+    # @param campaign_id [String] the id of campaign
+    # @return [JSON] a JSON object containing the campaign details
+    def self.cancel_campaign(campaign_id)
+      path = "#{CAMPAIGN}/#{campaign_id}/#{CANCEL}"
+
+      v1_request(HTTP_POST, path)
+    end
+  end
+end

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
+      identifier = { id_type => identifier }      
+      path = "#{DATA_PRIVACY}/#{DELETION_REQUEST}"
+      v2_request(HTTP_POST, path, identifier)
+    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/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

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

data/lib/klaviyo/apis/public.rb

@@ -8,16 +8,18 @@ module Klaviyo
     def self.identify(kwargs = {})
       defaults = {:id => nil,
                   :email => nil,
+                  :phone_number => nil,
                   :properties => {}
                  }
       kwargs = defaults.merge(kwargs)
 
-      if !check_email_or_id_exists(kwargs)
+      unless check_required_args(kwargs)
         return
       end
 
       properties = kwargs[:properties]
       properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
+      properties[:$phone_number] = kwargs[:phone_number] unless kwargs[:phone_number].to_s.empty?
       properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
 
       params = {
@@ -33,6 +35,7 @@ module Klaviyo
     # @param event [String] the event to track
     # @kwarg :id [String] the customer or profile id
     # @kwarg :email [String] the customer or profile email
+    # @kwarg :phone_number [String] the customer or profile phone number
     # @kwarg :properties [Hash] properties of the event
     # @kwargs :customer_properties [Hash] properties of the customer or profile
     # @kwargs :time [Integer] timestamp of the event
@@ -40,6 +43,7 @@ module Klaviyo
       defaults = {
         :id => nil,
         :email => nil,
+        :phone_number => nil,
         :properties => {},
         :customer_properties => {},
         :time => nil
@@ -47,12 +51,13 @@ module Klaviyo
 
       kwargs = defaults.merge(kwargs)
 
-      if !check_email_or_id_exists(kwargs)
+      unless check_required_args(kwargs)
         return
       end
 
       customer_properties = kwargs[:customer_properties]
       customer_properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
+      customer_properties[:$phone_number] = kwargs[:phone_number] unless kwargs[:phone_number].to_s.empty?
       customer_properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
 
       params = {
@@ -61,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,62 +10,81 @@ 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_email_or_id_exists(kwargs)
-      if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
-        raise Klaviyo::KlaviyoError.new(NO_ID_OR_EMAIL_ERROR)
+    def self.check_required_args(kwargs)
+      if kwargs[:email].to_s.empty? and kwargs[:phone_number].to_s.empty? and kwargs[:id].to_s.empty?
+        raise Klaviyo::KlaviyoError.new(REQUIRED_ARG_ERROR)
       else
         return true
       end

data/lib/klaviyo/klaviyo_module.rb

@@ -8,6 +8,9 @@ require_relative 'apis/public'
 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
@@ -19,5 +22,6 @@ 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'
-  NO_ID_OR_EMAIL_ERROR = 'You must identify a user by email or ID'
+  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.1
+  version: 2.0.6
 platform: ruby
 authors:
 - Klaviyo Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -74,6 +74,9 @@ extra_rdoc_files: []
 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
@@ -84,7 +87,7 @@ files:
 homepage: https://www.klaviyo.com/
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: You heard us, a Ruby wrapper for the Klaviyo API
 test_files: []