klaviyo 2.0.8 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b02aaf0e72a06b6d2bf999e9279a8b6c20c0f4f7652275fea1981ea0ab0683c5
-  data.tar.gz: 4b2ac021105853944c5bdbf47efa268addda7b1006f2683be04cadefb4db7ecc
+  metadata.gz: 48ce149f6493a79a418c85585a43079cf3735102c7f3090439a18f5f1c253425
+  data.tar.gz: 4633715d8397a09f1c8b70c0cf90e75eebfd2ced0cdf60d20c7b8a90aa0623f1
 SHA512:
-  metadata.gz: 561d598fa79624b0a2e271efb64676d55f39f09ca4ee787097061006f865f08f14d12faa49da7eea2a28523c3c0d96ed727feff2b40924b3965b1b1b234fb727
-  data.tar.gz: 934fe573a195fa8e307fc1c4383f810965d0b2636e81d8a442ece9c5b613ddef4d3eb3a1d5a159a82328edbb12cd0c87ab071a27ce5d7d57f2e8d7060a29433b
+  metadata.gz: f0295d3b07f3aa56ba3285ade79c35eb2bd9498b8931461b10cad486be12cdf0e507e64456f0c383255b8972a491212505df94a3a508c4ea9dfbd0f5973ab98a
+  data.tar.gz: cf4f1f10ebad10c3b5c19c0eb6f95862ffabf012f17451610061c6d140f188c752686a10db87c5a52465d346476d61463cee68a4f80c8f17c5e1dac6e34edde1

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.8'
-  s.date        = '2021-04-28'
+  s.version     = '2.3.0'
+  s.date        = '2021-10-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/campaigns.rb

@@ -6,36 +6,40 @@ module Klaviyo
     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()
-      v1_request(HTTP_GET, CAMPAIGNS)
+    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)
+    def self.get_campaign_details(campaign_id, api_key: nil)
       path = "#{CAMPAIGN}/#{campaign_id}"
 
-      v1_request(HTTP_GET, path)
+      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)
+    def self.send_campaign(campaign_id, api_key: nil)
       path = "#{CAMPAIGN}/#{campaign_id}/#{SEND}"
 
-      v1_request(HTTP_POST, path)
+      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)
+    def self.cancel_campaign(campaign_id, api_key: nil)
       path = "#{CAMPAIGN}/#{campaign_id}/#{CANCEL}"
 
-      v1_request(HTTP_POST, path)
+      v1_request(HTTP_POST, path, api_key: api_key)
     end
   end
 end

data/lib/klaviyo/apis/data_privacy.rb

@@ -6,14 +6,15 @@ module Klaviyo
     # 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)
+    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, **data)
+      v2_request(HTTP_POST, path, api_key: api_key, **data)
     end
   end
 end

data/lib/klaviyo/apis/email_templates.rb

@@ -8,21 +8,23 @@ module Klaviyo
 
     # 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()
-      v1_request(HTTP_GET, EMAIL_TEMPLATES)
+    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)
+    def self.create_template(name: nil, html: nil, api_key: nil)
       params = {
         name: name,
         html: html
       }
-      v1_request(HTTP_POST, EMAIL_TEMPLATES, content_type: CONTENT_URL_FORM, params: params)
+      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
@@ -30,47 +32,51 @@ module Klaviyo
     # @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:)
+    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, **params)
+      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)
+    def self.delete_template(template_id, api_key: nil)
       path = "#{EMAIL_TEMPLATE}/#{template_id}"
-      v1_request(HTTP_DELETE, path)
+      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:)
+    def self.clone_template(template_id, name:, api_key: nil)
       path = "#{EMAIL_TEMPLATE}/#{template_id}/#{CLONE}"
       params = {
         name: name
       }
-      v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
+      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: {})
+    def self.render_template(template_id, context: {}, api_key: nil)
       path = "#{EMAIL_TEMPLATE}/#{template_id}/#{RENDER}"
       params = {
         context: context
       }
-      v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
+      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
@@ -81,8 +87,9 @@ module Klaviyo
     # @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: {})
+    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,
@@ -91,7 +98,7 @@ module Klaviyo
         to: to,
         context: context
       }
-      v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
+      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

@@ -9,46 +9,51 @@ module Klaviyo
 
     # 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)
+    def self.create_list(list_name, api_key: nil)
       body = {
         :list_name => list_name
       }
-      v2_request(HTTP_POST, LISTS, **body)
+      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()
-      v2_request(HTTP_GET, LISTS)
+    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)
+    def self.get_list_details(list_id, api_key: nil)
       path = "#{LIST}/#{list_id}"
-      v2_request(HTTP_GET, path)
+      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)
+    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, **body)
+      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)
+    def self.delete_list(list_id, api_key: nil)
       path = "#{LIST}/#{list_id}"
-      v2_request(HTTP_DELETE, path)
+      v2_request(HTTP_DELETE, path, api_key: api_key)
     end
 
     # Check if profiles are in a list and not supressed
@@ -56,57 +61,61 @@ module Klaviyo
     # @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, emails: [], phone_numbers: [], push_tokens: [])
+    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, **params)
+      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, profiles: [])
+    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, **params)
+      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, emails: [])
+    def self.unsubscribe_from_list(list_id, api_key: nil, emails: [])
       path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
       params = {
         :emails => emails
       }
-      v2_request(HTTP_DELETE, path, **params)
+      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, profiles: [])
+    def self.add_to_list(list_id, api_key: nil, profiles: [])
       path = "#{LIST}/#{list_id}/#{MEMBERS}"
       params = {
         :profiles => profiles
       }
-      v2_request(HTTP_POST, path, **params)
+      v2_request(HTTP_POST, path, api_key: api_key, **params)
     end
 
     # Check if profiles are on a list
@@ -114,16 +123,17 @@ module Klaviyo
     # @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, emails: [], phone_numbers: [], push_tokens: [])
+    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, **params)
+      v2_request(HTTP_GET, path, api_key: api_key, **params)
     end
 
     # Remove profiles from a list
@@ -131,36 +141,39 @@ module Klaviyo
     # @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, emails: [], phone_numbers: [], push_tokens: [])
+    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, **params)
+      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, marker: nil)
+    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, **params)
+      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)
+    def self.get_group_members(list_id, api_key: nil)
       path = "#{GROUP}/#{list_id}/#{MEMBERS}/#{ALL}"
-      v2_request(HTTP_GET, path)
+      v2_request(HTTP_GET, path, api_key: api_key)
     end
   end
 end

data/lib/klaviyo/apis/metrics.rb

@@ -5,28 +5,30 @@ module Klaviyo
     # 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)
+    def self.get_metrics(page: DEFAULT_PAGE, count: DEFAULT_COUNT, api_key: nil)
       params = {
         :page => page,
         :count => count
       }
-      v1_request(HTTP_GET, METRICS, **params)
+      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)
+    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, **params)
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
     end
 
     # Returns a batched timeline for one specific type of metric.
@@ -34,15 +36,16 @@ module Klaviyo
     # @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)
+    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, **params)
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
     end
 
     # Export event data, optionally filtering and segmented on available event properties
@@ -54,6 +57,7 @@ module Klaviyo
     # @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,
@@ -62,7 +66,8 @@ module Klaviyo
                                measurement: nil,
                                where: nil,
                                by: nil,
-                               count: nil
+                               count: nil,
+                               api_key: nil
                                )
       path = "#{METRIC}/#{metric_id}/#{EXPORT}"
       params = {
@@ -74,7 +79,7 @@ module Klaviyo
         :by => by,
         :count => count
       }
-      v1_request(HTTP_GET, path, **params)
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
     end
   end
 end

data/lib/klaviyo/apis/profiles.rb

@@ -6,21 +6,23 @@ module Klaviyo
 
     # 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)
+    def self.get_profile_id_by_email(email, api_key: nil)
       path = "#{PEOPLE}/#{SEARCH}"
       params = {
         :email => email
       }
-      v2_request(HTTP_GET, path, **params)
+      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)
+    def self.get_person_attributes(person_id, api_key: nil)
       path = "#{PERSON}/#{person_id}"
-      v1_request(HTTP_GET, path)
+      v1_request(HTTP_GET, path, api_key: api_key)
     end
 
     # Add or update one more more attributes for a Person
@@ -37,15 +39,16 @@ module Klaviyo
     # @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)
+    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, **params)
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
     end
 
     # Listing a person's event timeline for a particular metric
@@ -54,15 +57,16 @@ module Klaviyo
     # @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)
+    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, **params)
+      v1_request(HTTP_GET, path, api_key: api_key, **params)
     end
   end
 end

data/lib/klaviyo/apis/public.rb

@@ -4,12 +4,17 @@ module Klaviyo
     #
     # @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 => {}
+                  :properties => {},
+                  :method => HTTP_GET,
+                  :token => nil
                  }
       kwargs = defaults.merge(kwargs)
 
@@ -22,12 +27,14 @@ module Klaviyo
       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 => Klaviyo.public_api_key,
+        :token => token,
         :properties => properties
       }
 
-      public_request(HTTP_GET, 'identify', **params)
+      public_request(kwargs[:method], 'identify', **params)
     end
 
     # Used for tracking events and customer behaviors
@@ -39,6 +46,8 @@ module Klaviyo
     # @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,
@@ -46,7 +55,9 @@ module Klaviyo
         :phone_number => nil,
         :properties => {},
         :customer_properties => {},
-        :time => nil
+        :time => nil,
+        :method => HTTP_GET,
+        :token => nil
       }
 
       kwargs = defaults.merge(kwargs)
@@ -60,15 +71,17 @@ module Klaviyo
       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 => Klaviyo.public_api_key,
+        :token => token,
         :event => event,
         :properties => kwargs[:properties],
         :customer_properties => customer_properties
       }
       params[:time] = kwargs[:time] if kwargs[:time]
 
-      public_request(HTTP_GET, 'track', **params)
+      public_request(kwargs[:method], 'track', **params)
     end
 
     def self.track_once(event, kwargs = {})

data/lib/klaviyo/client.rb

@@ -4,6 +4,9 @@ module Klaviyo
     V1_API = 'v1'
     V2_API = 'v2'
 
+    KL_VERSION = '2.3.0'
+    KL_USER_AGENT = "Ruby_Klaviyo/#{KL_VERSION}"
+
     HTTP_DELETE = 'delete'
     HTTP_GET = 'get'
     HTTP_POST = 'post'
@@ -24,12 +27,13 @@ module Klaviyo
     private
 
     def self.request(method, path, content_type, **kwargs)
-      check_private_api_key_exists()
+      check_private_api_key_exists(kwargs)
       url = "#{BASE_API_URL}/#{path}"
       connection = Faraday.new(
         url: url,
         headers: {
-          'Content-Type' => content_type
+          'Content-Type' => content_type,
+          'User-Agent' => KL_USER_AGENT
       })
       if content_type == CONTENT_JSON
         kwargs[:body] = kwargs[:body].to_json
@@ -40,17 +44,30 @@ module Klaviyo
     end
 
     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
+      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
 
     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 => Klaviyo.private_api_key
+            :api_key => priv_api_key
           }
         }
         data[:body] = data[:body].merge(kwargs[:params])
@@ -63,18 +80,20 @@ module Klaviyo
                     :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)
+        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
 
     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": "#{Klaviyo.private_api_key}"
+        :api_key => "#{priv_api_key}"
       }
       data = {}
-      data[:body] = key.merge(kwargs)
+      data[:body] = kwargs.merge(key)
       request(method, path, CONTENT_JSON, **data)
     end
 
@@ -90,16 +109,21 @@ module Klaviyo
       end
     end
 
-    def self.check_private_api_key_exists()
-      if !Klaviyo.private_api_key
+    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 self.check_public_api_key_exists()
-      if !Klaviyo.public_api_key
+    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)

data/lib/klaviyo/klaviyo_module.rb

@@ -24,4 +24,7 @@ module Klaviyo
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.3.0
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: You heard us, a Ruby wrapper for the Klaviyo API