klaviyo 2.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c50780aa07007d13ffcbfd5e88692dc46122641627511be21f4988012d48d20e
-  data.tar.gz: 453757a911094db7394000a2aa59d4a0f31a3cb6aa9196e50a749dac3e51b336
+SHA1:
+  metadata.gz: b500c9a9b23a831e8dbd4973b10e86420af64d70
+  data.tar.gz: 75585569e42545281d0622a40c5f888f261d6622
 SHA512:
-  metadata.gz: 62278b5560afe418dc8658e71646f36905cdb10c2b607b923377ea08c8ea247630fc782c6dbceda1d4fe2a88f5f332995abce6dcf90484cfbc1791516d4b6cd3
-  data.tar.gz: 1358f2f45b1e92144f8a43f0f52a291f3ee859af3e416924e003a1b7c7a02553965d6240fecf8289eb41167c422565c8909b57344b8baed9091c6f022801183b
+  metadata.gz: eecb6c11c4b4a893271f914db129724362ae6d74d5950ef79b5aa90e83939ea6c937af40122768b2e1f409640cef72587e19bfc3af05b1fda9dc33c4b46c3c20
+  data.tar.gz: 98d0566c1c134ea9ab32c0968927019d0231532aeeb72a86e432aeef60a4314f54dd12450269d9dc0762a373feef0b15dfdba8a68b2ef387fe8ce29c9576ff39

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     = '2.0.6'
-  s.date        = '2021-04-08'
+  s.version     = '1.0.0'
+  s.date        = '2014-09-06'
   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       = 'libraries@klaviyo.com'
+  s.email       = 'hello@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
+end

data/lib/klaviyo/client.rb

@@ -1,114 +1,74 @@
+require 'open-uri'
+require 'base64'
+require 'json'
+
 module Klaviyo
+  class KlaviyoError < StandardError; end
+  
   class Client
-    BASE_API_URL = 'https://a.klaviyo.com/api'
-    V1_API = 'v1'
-    V2_API = 'v2'
-
-    HTTP_DELETE = 'delete'
-    HTTP_GET = 'get'
-    HTTP_POST = 'post'
-    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, content_type, **kwargs)
-      check_private_api_key_exists()
-      url = "#{BASE_API_URL}/#{path}"
-      connection = Faraday.new(
-        url: url,
-        headers: {
-          '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] || nil
-      end
-    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
+    def initialize(api_key, url = 'http://a.klaviyo.com/')
+      @api_key = api_key
+      @url = url
     end
-
-    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)
+    
+    def track(event, kwargs = {})
+      defaults = {:id => nil, :email => nil, :properties => {}, :customer_properties => {}, :time => nil}
+      kwargs = defaults.merge(kwargs)
+      
+      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
-    end
+      
+      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?
 
-    def self.v2_request(method, path, **kwargs)
-      path = "#{V2_API}/#{path}"
-      key = {
-        "api_key": "#{Klaviyo.private_api_key}"
+      params = {
+        :token => @api_key,
+        :event => event,
+        :properties => kwargs[:properties],
+        :customer_properties => customer_properties,
+        :ip => ''
       }
-      data = {}
-      data[:body] = key.merge(kwargs)
-      request(method, path, CONTENT_JSON, data)
+      params[:time] = kwargs[:time].to_time.to_i if kwargs[:time]
+     
+      params = build_params(params)
+      request('crm/api/track', params)
     end
-
-    def self.build_params(params)
-      "data=#{CGI.escape(Base64.encode64(JSON.generate(params)).gsub(/\n/, ''))}"
+    
+    def track_once(event, opts = {})
+      opts.update('__track_once__' => true)
+      track(event, opts)
     end
-
-    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
+    
+    def identify(kwargs = {})
+      defaults = {:id => nil, :email => nil, :properties => {}}
+      kwargs = defaults.merge(kwargs)
+      
+      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
-    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.check_private_api_key_exists()
-      if !Klaviyo.private_api_key
-        raise KlaviyoError.new(NO_PRIVATE_API_KEY_ERROR)
-      end
+      params = build_params({
+        :token => @api_key,
+        :properties => properties
+      })
+      request('crm/api/identify', params)
     end
 
-    def self.check_public_api_key_exists()
-      if !Klaviyo.public_api_key
-        raise KlaviyoError.new(NO_PUBLIC_API_KEY_ERROR)
-      end
+    private
+    
+    def build_params(params)
+      'data=' + Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
     end
-
-    def self.encode_params(kwargs)
-      kwargs.select!{|k, v| v}
-      params = URI.encode_www_form(kwargs)
-
-      if !params.empty?
-        return "&#{params}"
-      end
+    
+    def request(path, params)
+        url = @url + path + '?' + params
+        open(url).read == '1' ? true : false
     end
   end
 end

data/lib/klaviyo.rb

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

metadata

@@ -1,109 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Klaviyo Team
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2014-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   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'
 - !ruby/object:Gem::Dependency
   name: rack
   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'
 - !ruby/object:Gem::Dependency
   name: escape
   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'
-- !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: libraries@klaviyo.com
+email: hello@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/klaviyo.rb
 - lib/rack/klaviyo.rb
 homepage: https://www.klaviyo.com/
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
 specification_version: 4
 summary: You heard us, a Ruby wrapper for the Klaviyo API
 test_files: []

data/lib/klaviyo/apis/campaigns.rb

@@ -1,41 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

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

data/lib/klaviyo/apis/lists.rb

@@ -1,166 +0,0 @@
-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
-    # @return will return with HTTP OK on success
-    def self.create_list(list_name)
-      body = {
-        :list_name => list_name
-      }
-      v2_request(HTTP_POST, LISTS, body)
-    end
-
-    # Retrieves all the lists in the Klaviyo account
-    # @return [List] a list of JSON objects of the name and id for each list
-    def self.get_lists()
-      v2_request(HTTP_GET, LISTS)
-    end
-
-    # Retrieves the details of the list
-    # @param list_id [String] the id of the list
-    # @return [JSON] a JSON object containing information about the list
-    def self.get_list_details(list_id)
-      path = "#{LIST}/#{list_id}"
-      v2_request(HTTP_GET, path)
-    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
-    # @return will return with HTTP OK on success
-    def self.update_list_details(list_id, list_name)
-      path = "#{LIST}/#{list_id}"
-      body = {
-        :list_name => list_name
-      }
-      v2_request(HTTP_PUT, path, body)
-    end
-
-    # Deletes a list
-    # @param list_id [String] the id of the list
-    # @return will return with HTTP OK on success
-    def self.delete_list(list_id)
-      path = "#{LIST}/#{list_id}"
-      v2_request(HTTP_DELETE, path)
-    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
-    # @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: [])
-      path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
-      params = {
-        :emails => emails,
-        :phone_numbers => phone_numbers,
-        :push_tokens => push_tokens
-      }
-      v2_request(HTTP_GET, path, 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.
-    # @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: [])
-      path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
-      params = {
-        :profiles => profiles
-      }
-      v2_request(HTTP_POST, path, 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
-    # @return will return with HTTP OK on success
-    def self.unsubscribe_from_list(list_id, emails: [])
-      path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
-      params = {
-        :emails => emails
-      }
-      v2_request(HTTP_DELETE, path, 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
-    # @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: [])
-      path = "#{LIST}/#{list_id}/#{MEMBERS}"
-      params = {
-        :profiles => profiles
-      }
-      v2_request(HTTP_POST, path, 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
-    # @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: [])
-      path = "#{LIST}/#{list_id}/#{MEMBERS}"
-      params = {
-        :emails => emails,
-        :phone_numbers => phone_numbers,
-        :push_tokens => push_tokens
-      }
-      v2_request(HTTP_GET, path, 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
-    # @return will return with HTTP OK on success
-    def self.remove_from_list(list_id, 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)
-    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
-    # @return [List] A list of JSON object for each profile with the reason for exclusion
-    def self.get_list_exclusions(list_id, marker: nil)
-      path = "#{LIST}/#{list_id}/#{EXCLUSIONS}/#{ALL}"
-      params = {
-        :marker => marker
-      }
-      v2_request(HTTP_GET, path, params)
-    end
-
-    # Get all of the emails, phone numbers, and push tokens for profiles in a given list or segment
-    # @param list_id [String] the id of the list
-    # @param marker [Integer] a marker from a previous call to get the next batch
-    # @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)
-      path = "#{GROUP}/#{list_id}/#{MEMBERS}/#{ALL}"
-      v2_request(HTTP_GET, path)
-    end
-  end
-end

data/lib/klaviyo/apis/metrics.rb

@@ -1,80 +0,0 @@
-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
-    # @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)
-      params = {
-        :page => page,
-        :count => count
-      }
-      v1_request(HTTP_GET, METRICS, 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'.
-    # @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)
-      path = "#{METRICS}/#{TIMELINE}"
-      params = {
-        :since => since,
-        :count => count,
-        :sort => sort
-      }
-      v1_request(HTTP_GET, path, 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'.
-    # @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)
-      path = "#{METRIC}/#{metric_id}/#{TIMELINE}"
-      params = {
-        :since => since,
-        :count => count,
-        :sort => sort
-      }
-      v1_request(HTTP_GET, path, 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.
-    # @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
-                               )
-      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, params)
-    end
-  end
-end

data/lib/klaviyo/apis/profiles.rb

@@ -1,68 +0,0 @@
-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
-    # @return returns a person object
-    def self.get_person_attributes(person_id)
-      path = "#{PERSON}/#{person_id}"
-      v1_request(HTTP_GET, path)
-    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'.
-    # @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)
-      path = "#{PERSON}/#{person_id}/#{METRICS}/#{TIMELINE}"
-      params = {
-        :since => since,
-        :count => count,
-        :sort => sort
-      }
-      v1_request(HTTP_GET, path, 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'.
-    # @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)
-      path = "#{PERSON}/#{person_id}/#{METRIC}/#{metric_id}/#{TIMELINE}"
-      params = {
-        :since => since,
-        :count => count,
-        :sort => sort
-      }
-      v1_request(HTTP_GET, path, params)
-    end
-  end
-end

data/lib/klaviyo/apis/public.rb

@@ -1,79 +0,0 @@
-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 :properties [Hash] properties of the profile to add or update
-    def self.identify(kwargs = {})
-      defaults = {:id => nil,
-                  :email => nil,
-                  :phone_number => nil,
-                  :properties => {}
-                 }
-      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?
-
-      params = {
-        :token => Klaviyo.public_api_key,
-        :properties => properties
-      }
-
-      public_request(HTTP_GET, '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
-    def self.track(event, kwargs = {})
-      defaults = {
-        :id => nil,
-        :email => nil,
-        :phone_number => nil,
-        :properties => {},
-        :customer_properties => {},
-        :time => 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?
-
-      params = {
-        :token => Klaviyo.public_api_key,
-        :event => event,
-        :properties => kwargs[:properties],
-        :customer_properties => customer_properties
-      }
-      params[:time] = kwargs[:time] if kwargs[:time]
-
-      public_request(HTTP_GET, 'track', **params)
-    end
-
-    def self.track_once(event, kwargs = {})
-      kwargs.update('__track_once__' => true)
-      track(event, kwargs)
-    end
-  end
-end

data/lib/klaviyo/klaviyo_module.rb

@@ -1,27 +0,0 @@
-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'
-end