klaviyo 1.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4761ff7c9edac6dd8dec7efd826f0b9a903022ced70b8938d9db3adfdc9f16ac
-  data.tar.gz: f9bca9ccb221bf7a30387a60e4fde3f6adba9e814702266fc0b869c5c470046b
+  metadata.gz: e41bce0307198c5fdf2ed370683115011973e35a53a79e106ce5fbf3b9ae3db1
+  data.tar.gz: c3a43df8eec9a79c7fa7b0e7c6d61f8bb715d3e3c0e62b855e3d822ea831a027
 SHA512:
-  metadata.gz: 0da39baf09b301c7df78833d2a9d62bc8f72b2512c06b4c67ca247a863f72d4563512915037ad80aff05168cb41d3830dbec56b3e2bda3605d7a8f1b7826baf4
-  data.tar.gz: d555098395599b4e1b9c725f815229949e0c208c00d0b387fcc00ac3071763d5aef830e3cf5316f71e7f84900e950bad27757370ab5a0b810f07a05e519541e0
+  metadata.gz: d562be7fd7515a89585448e2ecff320f39fe728a39b4124c248b8db4673dae68c1a3fee7f5189d4f1bfffff6b0b131d5975c6550bec03a2777790898064e0fe6
+  data.tar.gz: 8524d7358694da9ddddee84d0a2fe4fdaf532ecdd37502ab07fa8e328199c9309eaeeb1d6a177f76569d83c39df8770bc024ee905729be9986a5a7f8339fd4c8

data/klaviyo.gemspec

@@ -1,18 +1,18 @@
-files = ['klaviyo.gemspec', '{lib}/**/*'].map {|f| Dir[f]}.flatten
+files = ['klaviyo.gemspec', '{lib}/**/**/*'].map {|f| Dir[f]}.flatten
 
 Gem::Specification.new do |s|
   s.name        = 'klaviyo'
-  s.version     = '1.2.0'
-  s.date        = '2020-09-28'
+  s.version     = '2.4.0'
+  s.date        = '2022-01-19'
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'
   s.description = 'Ruby wrapper for the Klaviyo API'
   s.authors     = ['Klaviyo Team']
-  s.email       = 'hello@klaviyo.com'
+  s.email       = 'libraries@klaviyo.com'
   s.files       = files
   s.homepage = 'https://www.klaviyo.com/'
   s.require_path = 'lib'
-  s.has_rdoc    = false
   s.add_dependency 'json'
   s.add_dependency 'rack'
   s.add_dependency 'escape'
+  s.add_dependency 'faraday'
 end

data/lib/klaviyo/apis/campaigns.rb

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

data/lib/klaviyo/apis/data_privacy.rb

@@ -0,0 +1,20 @@
+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
+    # @kwarg :api_key [String] private API key for this request
+    # @return a dictionary with a confirmation that deletion task submitted for the customer
+    def self.request_profile_deletion(id_type, identifier, api_key: nil)
+      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, api_key: api_key, **data)
+    end
+  end
+end

data/lib/klaviyo/apis/email_templates.rb

@@ -0,0 +1,104 @@
+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.
+    # @kwarg :api_key [String] private API key for this request
+    # @return [List] of JSON formatted email template objects
+    def self.get_templates(api_key: nil)
+      v1_request(HTTP_GET, EMAIL_TEMPLATES, api_key: api_key)
+    end
+
+    # Creates a new email template
+    # @param :name [String] The name of the email template
+    # @param :html [String] The HTML content for this template
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing information about the email template
+    def self.create_template(name: nil, html: nil, api_key: nil)
+      params = {
+        name: name,
+        html: html
+      }
+      v1_request(HTTP_POST, EMAIL_TEMPLATES, api_key: api_key, 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
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing information about the email template
+    def self.update_template(template_id, name:, html:, api_key: nil)
+      path = "#{EMAIL_TEMPLATE}/#{template_id}"
+      params = {
+        name: name,
+        html: html
+      }
+      v1_request(HTTP_PUT, path, api_key: api_key, **params)
+    end
+
+    # Deletes a given template.
+    # @param template_id [String] The id of the email template
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing information about the email template
+    def self.delete_template(template_id, api_key: nil)
+      path = "#{EMAIL_TEMPLATE}/#{template_id}"
+      v1_request(HTTP_DELETE, path, api_key: api_key)
+    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
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing information about the email template
+    def self.clone_template(template_id, name:, api_key: nil)
+      path = "#{EMAIL_TEMPLATE}/#{template_id}/#{CLONE}"
+      params = {
+        name: name
+      }
+      v1_request(HTTP_POST, path, api_key: api_key, 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
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing information about the email template
+    def self.render_template(template_id, context: {}, api_key: nil)
+      path = "#{EMAIL_TEMPLATE}/#{template_id}/#{RENDER}"
+      params = {
+        context: context
+      }
+      v1_request(HTTP_POST, path, api_key: api_key, 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
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing information about the email template
+    def self.send_template(template_id, from_email:, from_name:, subject:, to:, context: {}, api_key: nil)
+      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, api_key: api_key, content_type: CONTENT_URL_FORM, params: params)
+    end
+  end
+end

data/lib/klaviyo/apis/lists.rb

@@ -0,0 +1,182 @@
+module Klaviyo
+  class Lists < Client
+    EXCLUSIONS = 'exclusions'
+    GROUP = 'group'
+    LIST = 'list'
+    LISTS = 'lists'
+    MEMBERS = 'members'
+    SUBSCRIBE = 'subscribe'
+
+    # Creates a new list
+    # @param list_name [String] the list name
+    # @kwarg :api_key [String] private API key for this request
+    # @return will return with HTTP OK on success
+    def self.create_list(list_name, api_key: nil)
+      body = {
+        :list_name => list_name
+      }
+      v2_request(HTTP_POST, LISTS, api_key: api_key, **body)
+    end
+
+    # Retrieves all the lists in the Klaviyo account
+    # @kwarg :api_key [String] private API key for this request
+    # @return [List] a list of JSON objects of the name and id for each list
+    def self.get_lists(api_key: nil)
+      v2_request(HTTP_GET, LISTS, api_key: api_key)
+    end
+
+    # Retrieves the details of the list
+    # @param list_id [String] the id of the list
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing information about the list
+    def self.get_list_details(list_id, api_key: nil)
+      path = "#{LIST}/#{list_id}"
+      v2_request(HTTP_GET, path, api_key: api_key)
+    end
+
+    # Updates the properties of a list
+    # @param list_id [String] the id of the list
+    # @param list_name [String] the new name of the list
+    # @kwarg :api_key [String] private API key for this request
+    # @return will return with HTTP OK on success
+    def self.update_list_details(list_id, list_name, api_key: nil)
+      path = "#{LIST}/#{list_id}"
+      body = {
+        :list_name => list_name
+      }
+      v2_request(HTTP_PUT, path, api_key: api_key, **body)
+    end
+
+    # Deletes a list
+    # @param list_id [String] the id of the list
+    # @kwarg :api_key [String] private API key for this request
+    # @return will return with HTTP OK on success
+    def self.delete_list(list_id, api_key: nil)
+      path = "#{LIST}/#{list_id}"
+      v2_request(HTTP_DELETE, path, api_key: api_key)
+    end
+
+    # Check if profiles are in a list and not supressed
+    # @param list_id [String] the id of the list
+    # @param :emails [List] the emails of the profiles to check
+    # @param :phone_numbers [List] the phone numbers of the profiles to check
+    # @param :push_tokens [List] push tokens of the profiles to check
+    # @kwarg :api_key [String] private API key for this request
+    # @return A list of JSON objects of the profiles. Profiles that are
+    #   supressed or not found are not included.
+    def self.check_list_subscriptions(list_id, api_key: nil, emails: [], phone_numbers: [], push_tokens: [])
+      path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
+      params = {
+        :emails => emails,
+        :phone_numbers => phone_numbers,
+        :push_tokens => push_tokens
+      }
+      v2_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+
+    # Subscribe profiles to a list.
+    # @param list_id [String] the id of the list
+    # @param profiles [List] a list of JSON objects.  Each object requires either
+    #   an email or phone number key.
+    # @kwarg :api_key [String] private API key for this request
+    # @return will retun HTTP OK on success. If the list is single opt-in then a
+    #   list of records containing the email address, phone number, push token,
+    #   and the corresponding profile ID will also be included.
+    def self.add_subscribers_to_list(list_id, api_key: nil, profiles: [])
+      path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
+      params = {
+        :profiles => profiles
+      }
+      v2_request(HTTP_POST, path, api_key: api_key, **params)
+    end
+
+    # Unsubscribe and remove profiles from a list
+    # @param list_id [String] the id of the list
+    # @param :emails [List] the emails of the profiles to check
+    # @kwarg :api_key [String] private API key for this request
+    # @return will return with HTTP OK on success
+    def self.unsubscribe_from_list(list_id, api_key: nil, emails: [])
+      path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
+      params = {
+        :emails => emails
+      }
+      v2_request(HTTP_DELETE, path, api_key: api_key, **params)
+    end
+
+    # Add profiles to a list
+    # @param list_id [String] the id of the list
+    # @param :profiles [List] A list of JSON objects.  Each object is a profile
+    #   that will be added to the list
+    # @kwarg :api_key [String] private API key for this request
+    # @return will return with HTTP OK on success and a list of records of the
+    #   corresponding profile id
+    def self.add_to_list(list_id, api_key: nil, profiles: [])
+      path = "#{LIST}/#{list_id}/#{MEMBERS}"
+      params = {
+        :profiles => profiles
+      }
+      v2_request(HTTP_POST, path, api_key: api_key, **params)
+    end
+
+    # Check if profiles are on a list
+    # @param list_id [String] the id of the list
+    # @param :emails [List] the emails of the profiles to check
+    # @param :phone_numbers [List] the phone numbers of the profiles to check
+    # @param :push_tokens [List] push tokens of the profiles to check
+    # @kwarg :api_key [String] private API key for this request
+    # @return A list of JSON objects of the profiles. Profiles that are
+    #   supressed or not found are not included.
+    def self.check_list_memberships(list_id, api_key: nil, emails: [], phone_numbers: [], push_tokens: [])
+      path = "#{LIST}/#{list_id}/#{MEMBERS}"
+      params = {
+        :emails => emails,
+        :phone_numbers => phone_numbers,
+        :push_tokens => push_tokens
+      }
+      v2_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+
+    # Remove profiles from a list
+    # @param list_id [String] the id of the list
+    # @param :emails [List] the emails of the profiles to check
+    # @param :phone_numbers [List] the phone numbers of the profiles to check
+    # @param :push_tokens [List] push tokens of the profiles to check
+    # @kwarg :api_key [String] private API key for this request
+    # @return will return with HTTP OK on success
+    def self.remove_from_list(list_id, api_key: nil, emails: [], phone_numbers: [], push_tokens: [])
+      path = "#{LIST}/#{list_id}/#{MEMBERS}"
+      params = {
+        :emails => emails,
+        :phone_numbers => phone_numbers,
+        :push_tokens => push_tokens
+      }
+      v2_request(HTTP_DELETE, path, api_key: api_key, **params)
+    end
+
+    # Get all emails, phone numbers, along with reasons for list exclusion
+    # @param list_id [String] the id of the list
+    # @param marker [Integer] a marker from a previous call to get the next batch
+    # @kwarg :api_key [String] private API key for this request
+    # @return [List] A list of JSON object for each profile with the reason for exclusion
+    def self.get_list_exclusions(list_id, api_key: nil, marker: nil)
+      path = "#{LIST}/#{list_id}/#{EXCLUSIONS}/#{ALL}"
+      params = {
+        :marker => marker
+      }
+      v2_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+
+    # Get all of the emails, phone numbers, and push tokens for profiles in a given list or segment
+    # @param list_id [String] the id of the list
+    # @param marker [Integer] a marker from a previous call to get the next batch
+    # @kwarg :api_key [String] private API key for this request
+    # @return [List] A list of JSON objects for each profile with the id, email, phone number, and push token
+    def self.get_group_members(list_id, api_key: nil, marker: nil)
+      path = "#{GROUP}/#{list_id}/#{MEMBERS}/#{ALL}"
+      params = {
+        marker: marker
+      }
+      v2_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+  end
+end

data/lib/klaviyo/apis/metrics.rb

@@ -0,0 +1,85 @@
+module Klaviyo
+  class Metrics < Client
+    EXPORT = 'export'
+
+    # Returns a list of all metrics in Klaviyo
+    # @param page [Integer] which page to return, default 0
+    # @param count [Integer] number of results to return, default 100
+    # @kwarg :api_key [String] private API key for this request
+    # @return a dictionary with a data property that contains an array of all the metrics
+    def self.get_metrics(page: DEFAULT_PAGE, count: DEFAULT_COUNT, api_key: nil)
+      params = {
+        :page => page,
+        :count => count
+      }
+      v1_request(HTTP_GET, METRICS, api_key: api_key, **params)
+    end
+
+    # Returns a batched timeline of all events in your Klaviyo account.
+    # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request.  Default is the current time.
+    # @param count [Integer] number of results to return, default 100
+    # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline.  Default is 'desc'.
+    # @kwarg :api_key [String] private API key for this request
+    # @return a dictionary with a data property that contains an array of the metrics
+    def self.get_metrics_timeline(since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC, api_key: nil)
+      path = "#{METRICS}/#{TIMELINE}"
+      params = {
+        :since => since,
+        :count => count,
+        :sort => sort
+      }
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+
+    # Returns a batched timeline for one specific type of metric.
+    # @param metric_id [String] the id of the metric
+    # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request.  Default is the current time.
+    # @param count [Integer] number of results to return, default 100
+    # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline.  Default is 'desc'.
+    # @kwarg :api_key [String] private API key for this request
+    # @return a dictionary with a data property that contains information about what metric the event tracks
+    def self.get_metric_timeline(metric_id, since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC, api_key: nil)
+      path = "#{METRIC}/#{metric_id}/#{TIMELINE}"
+      params = {
+        :since => since,
+        :count => count,
+        :sort => sort
+      }
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+
+    # Export event data, optionally filtering and segmented on available event properties
+    # @param metric_id [String] the id of the metric
+    # @param start_date [String] Beginning of the timeframe to pull event data for.  Default is 1 month ago
+    # @param end_date [String] End of the timeframe to pull event data for.  Default is the current day
+    # @param unit [String] Granularity to bucket data points into - one of ‘day’, ‘week’, or ‘month’. Defaults to ‘day’.
+    # @param measurement [String or JSON-encoded list] Type of metric to fetch
+    # @param where [JSON-encoded list] Conditions to use to filter the set of events. A max of 1 condition can be given.
+    # @param by [String] The name of a property to segment the event data on. Where and by parameters cannot be specified at the same time.
+    # @param count [Integer] Maximum number of segments to return. The default value is 25.
+    # @kwarg :api_key [String] private API key for this request
+    # @return A dictionary relecting the input request parameters as well as a results property
+    def self.get_metric_export(metric_id,
+                               start_date: nil,
+                               end_date: nil,
+                               unit: nil,
+                               measurement: nil,
+                               where: nil,
+                               by: nil,
+                               count: nil,
+                               api_key: nil
+                               )
+      path = "#{METRIC}/#{metric_id}/#{EXPORT}"
+      params = {
+        :start_date => start_date,
+        :end_date => end_date,
+        :unit => unit,
+        :measurement => measurement,
+        :where => where,
+        :by => by,
+        :count => count
+      }
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+  end
+end

data/lib/klaviyo/apis/profiles.rb

@@ -0,0 +1,72 @@
+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
+    # @kwarg :api_key [String] private API key for this request
+    # @return [JSON] a JSON object containing id of the profile
+    def self.get_profile_id_by_email(email, api_key: nil)
+      path = "#{PEOPLE}/#{SEARCH}"
+      params = {
+        :email => email
+      }
+      v2_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+
+    # Retrieve all the data attributes for a Klaviyo Person ID.
+    # @param person_id [String] the id of the profile
+    # @kwarg :api_key [String] private API key for this request
+    # @return returns a person object
+    def self.get_person_attributes(person_id, api_key: nil)
+      path = "#{PERSON}/#{person_id}"
+      v1_request(HTTP_GET, path, api_key: api_key)
+    end
+
+    # Add or update one more more attributes for a Person
+    # @param person_id [String] the id of the profile
+    # @param kwargs [Key/value pairs] attributes to add/update in the profile
+    # @return returns the updated person object
+    def self.update_person_attributes(person_id, kwargs = {})
+      path = "#{PERSON}/#{person_id}"
+      v1_request(HTTP_PUT, path, **kwargs)
+    end
+
+    # Listing a person's event timeline
+    # @param person_id [String] the id of the profile
+    # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request.  Default is the current time.
+    # @param count [Integer] number of results to return, default 100
+    # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline.  Default is 'desc'.
+    # @kwarg :api_key [String] private API key for this request
+    # @return returns a dictionary containing a list of metric event objects
+    def self.get_person_metrics_timeline(person_id, since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC, api_key: nil)
+      path = "#{PERSON}/#{person_id}/#{METRICS}/#{TIMELINE}"
+      params = {
+        :since => since,
+        :count => count,
+        :sort => sort
+      }
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+
+    # Listing a person's event timeline for a particular metric
+    # @param person_id [String] the id of the profile
+    # @param metric_id [String] the id of the metric
+    # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request.  Default is the current time.
+    # @param count [Integer] number of results to return, default 100
+    # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline.  Default is 'desc'.
+    # @kwarg :api_key [String] private API key for this request
+    # @return returns a dictionary containing a list of metric event objects
+    def self.get_person_metric_timeline(person_id, metric_id, since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC, api_key: nil)
+      path = "#{PERSON}/#{person_id}/#{METRIC}/#{metric_id}/#{TIMELINE}"
+      params = {
+        :since => since,
+        :count => count,
+        :sort => sort
+      }
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
+    end
+  end
+end

data/lib/klaviyo/apis/public.rb

@@ -0,0 +1,92 @@
+module Klaviyo
+  class Public < Client
+    # Used for identifying customers and managing profile properties
+    #
+    # @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 profile to add or update
+    # @kwarg :token [String] public API token for this request
+    # @kwargs :method [String] the HTTP method to use for the request. Accepts 'get' or 'post'.  Defaults to 'get'.
+    def self.identify(kwargs = {})
+      defaults = {:id => nil,
+                  :email => nil,
+                  :phone_number => nil,
+                  :properties => {},
+                  :method => HTTP_GET,
+                  :token => nil
+                 }
+      kwargs = defaults.merge(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?
+
+      token = kwargs[:token] || Klaviyo.public_api_key || nil
+
+      params = {
+        :token => token,
+        :properties => properties
+      }
+
+      public_request(kwargs[:method], 'identify', **params)
+    end
+
+    # Used for tracking events and customer behaviors
+    #
+    # @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
+    # @kwarg :token [String] public API token for this request
+    # @kwargs :method [String] the HTTP method to use for the request. Accepts 'get' or 'post'.  Defaults to 'get'.
+    def self.track(event, kwargs = {})
+      defaults = {
+        :id => nil,
+        :email => nil,
+        :phone_number => nil,
+        :properties => {},
+        :customer_properties => {},
+        :time => nil,
+        :method => HTTP_GET,
+        :token => nil
+      }
+
+      kwargs = defaults.merge(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?
+
+      token = kwargs[:token] || Klaviyo.public_api_key || nil
+
+      params = {
+        :token => token,
+        :event => event,
+        :properties => kwargs[:properties],
+        :customer_properties => customer_properties
+      }
+      params[:time] = kwargs[:time] if kwargs[:time]
+
+      public_request(kwargs[:method], 'track', **params)
+    end
+
+    def self.track_once(event, kwargs = {})
+      kwargs.update('__track_once__' => true)
+      track(event, kwargs)
+    end
+  end
+end

data/lib/klaviyo/client.rb

@@ -1,77 +1,138 @@
-require 'open-uri'
-require 'base64'
-require 'json'
-
 module Klaviyo
-  class KlaviyoError < StandardError; end
-
   class Client
-    VERSION = '1.2.0'
-    KL_USER_AGENT = "Ruby_Klaviyo/#{VERSION}"
+    BASE_API_URL = 'https://a.klaviyo.com/api'
+    V1_API = 'v1'
+    V2_API = 'v2'
 
-    def initialize(api_key, url = 'https://a.klaviyo.com/')
-      @api_key = api_key
-      @url = url
-    end
+    KL_VERSION = '2.4.0'
+    KL_USER_AGENT = "Ruby_Klaviyo/#{KL_VERSION}"
 
-    def track(event, kwargs = {})
-      defaults = {:id => nil, :email => nil, :properties => {}, :customer_properties => {}, :time => nil}
-      kwargs = defaults.merge(kwargs)
+    HTTP_DELETE = 'delete'
+    HTTP_GET = 'get'
+    HTTP_POST = 'post'
+    HTTP_PUT = 'put'
 
-      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
+    ALL = 'all'
+    METRIC = 'metric'
+    METRICS = 'metrics'
+    TIMELINE = 'timeline'
 
-      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?
+    DEFAULT_COUNT = 100
+    DEFAULT_PAGE = 0
+    DEFAULT_SORT_DESC = 'desc'
 
-      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]
+    CONTENT_JSON = 'application/json'
+    CONTENT_URL_FORM = 'application/x-www-form-urlencoded'
 
-      params = build_params(params)
-      request('api/track', params)
-    end
+    private
 
-    def track_once(event, opts = {})
-      opts.update('__track_once__' => true)
-      track(event, opts)
+    def self.request(method, path, content_type, **kwargs)
+      check_private_api_key_exists(kwargs)
+      url = "#{BASE_API_URL}/#{path}"
+      connection = Faraday.new(
+        url: url,
+        headers: {
+          'Content-Type' => content_type,
+          'User-Agent' => KL_USER_AGENT
+      })
+      if content_type == CONTENT_JSON
+        kwargs[:body] = kwargs[:body].to_json
+      end
+      response = connection.send(method) do |req|
+        req.body = kwargs[:body] || nil
+      end
     end
 
-    def identify(kwargs = {})
-      defaults = {:id => nil, :email => nil, :properties => {}}
-      kwargs = defaults.merge(kwargs)
+    def self.public_request(method, path, **kwargs)
+      check_public_api_key_is_valid(kwargs[:token])
+      if method == HTTP_GET
+        params = build_params(kwargs)
+        url = "#{BASE_API_URL}/#{path}?#{params}"
+        res = Faraday.get(url, {}, { 'User-Agent' => KL_USER_AGENT }).body
+      elsif method == HTTP_POST
+        url = URI("#{BASE_API_URL}/#{path}")
+        response = Faraday.post(url) do |req|
+          req.headers['Content-Type'] = CONTENT_URL_FORM
+          req.headers['Accept'] = 'text/html'
+          req.headers['User-Agent'] = KL_USER_AGENT
+          req.body = {data: "#{kwargs.to_json}"}
+        end
+      else
+        raise KlaviyoError.new(INVALID_HTTP_METHOD)
+      end
+    end
 
-      if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
-        raise KlaviyoError.new('You must identify a user by email or ID')
+    def self.v1_request(method, path, content_type: CONTENT_JSON, **kwargs)
+      if content_type == CONTENT_URL_FORM
+        priv_api_key = kwargs[:api_key] || Klaviyo.private_api_key || nil
+        data = {
+          :body => {
+            :api_key => priv_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)
+        priv_api_key = kwargs[:api_key] || Klaviyo.private_api_key || nil
+        full_url = "#{V1_API}/#{path}?api_key=#{priv_api_key}#{query_params}"
+        request(method, full_url, content_type, body: {api_key: priv_api_key})
       end
+    end
 
-      properties = kwargs[:properties]
-      properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
-      properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
+    def self.v2_request(method, path, **kwargs)
+      path = "#{V2_API}/#{path}"
+      priv_api_key = kwargs[:api_key] || Klaviyo.private_api_key || nil
+      key = {
+        :api_key => "#{priv_api_key}"
+      }
+      data = {}
+      data[:body] = kwargs.merge(key)
+      request(method, path, CONTENT_JSON, **data)
+    end
 
-      params = build_params({
-        :token => @api_key,
-        :properties => properties
-      })
-      request('api/identify', params)
+    def self.build_params(params)
+      "data=#{CGI.escape(Base64.encode64(JSON.generate(params)).gsub(/\n/, ''))}"
     end
 
-    private
+    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
+    end
 
-    def build_params(params)
-      "data=#{CGI.escape Base64.encode64(JSON.generate(params)).gsub(/\n/,'')}"
+    def self.check_private_api_key_exists(kwargs)
+      if !Klaviyo.private_api_key && kwargs[:body][:api_key].nil?
+        raise KlaviyoError.new(NO_PRIVATE_API_KEY_ERROR)
+      end
     end
 
-    def request(path, params)
-      url = "#{@url}#{path}?#{params}"
-      open(url, 'User-Agent' => KL_USER_AGENT).read == '1'
+    def self.check_public_api_key_is_valid(token)
+      if !token
+        raise KlaviyoError.new(NO_PUBLIC_API_KEY_ERROR)
+      end
+      if ( token =~ /pk_\w{34}$/ ) == 0
+        warn(PRIVATE_KEY_AS_PUBLIC)
+      elsif ( token =~ /\w{6}$/ ) != 0
+        raise KlaviyoError.new(INCORRECT_PUBLIC_API_KEY_LENGTH)
+      end
+    end
+
+    def self.encode_params(kwargs)
+      kwargs.select!{|k, v| v}
+      params = URI.encode_www_form(kwargs)
+
+      if !params.empty?
+        return "&#{params}"
+      end
     end
   end
 end

data/lib/klaviyo/klaviyo_module.rb

@@ -0,0 +1,30 @@
+require 'open-uri'
+require 'base64'
+require 'json'
+require 'faraday'
+
+require_relative './client'
+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
+    attr_accessor :public_api_key
+    attr_accessor :private_api_key
+  end
+
+  class KlaviyoError < StandardError; end
+
+  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'
+  PRIVATE_KEY_AS_PUBLIC = 'Private API key added in place of Public API key'
+  INCORRECT_PUBLIC_API_KEY_LENGTH = 'Public API Key must be 6 characters'
+  INVALID_HTTP_METHOD = 'Invalid HTTP method present, please use "get" or "post"'
+end

data/lib/klaviyo.rb

@@ -1 +1 @@
-require 'klaviyo/client'
+require 'klaviyo/klaviyo_module'

data/lib/rack/klaviyo.rb

@@ -55,6 +55,7 @@ module Rack
       <script text="text/javascript">
         var _learnq = _learnq || [];
         _learnq.push(['account', '#{@api_key}']);
+
         (function () {
           var b = document.createElement('script'); b.type = 'text/javascript'; b.async = true;
           b.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'a.klaviyo.com/media/js/analytics/analytics.js';

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,15 +52,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for the Klaviyo API
-email: hello@klaviyo.com
+email: libraries@klaviyo.com
 executables: []
 extensions: []
 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
+- lib/klaviyo/apis/public.rb
 - lib/klaviyo/client.rb
+- lib/klaviyo/klaviyo_module.rb
 - lib/rack/klaviyo.rb
 homepage: https://www.klaviyo.com/
 licenses: []