klaviyo 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438fe72ddfdd5e636f8026c8e0b02daf22586e58c4a2628065db088b633bb1be
-  data.tar.gz: c586d57114a208aa6843fa6dd218d2e2ceae454282c8b4b297a7ab122cd89dd3
+  metadata.gz: 28360ee80e88095a3cab7c279740506e843483536659a59b2ac4473e2163e489
+  data.tar.gz: 68e8e4561cdb1790f786b195a83ae3ea557aaf69ff9c7c9356b09cee33f724d6
 SHA512:
-  metadata.gz: bce5653e39bc762647ee52f29a3c0b2d8ea672b782a5192e9ca3d3da11a41e388f67a5c11f7eb28ce7f274f691a445677ee345eb3855ba2fa422ed30407a282f
-  data.tar.gz: 5f831ad7a264a16b697435e1cafe6c942f7c58572bdf67041d74b3f65f398fd4ba948e0c70edbccb6d5839d16f0831553ce2868fe43b6b6fe796d9dfef2e2103
+  metadata.gz: 46def1393ec8838ccfe6c966f0aa0e0651fa3354b6c580a42e764245636aab1e7cc7894d221c405fd23abed2c7bed2ea3a0cc3f1b04841f2ee061538bf5297b0
+  data.tar.gz: 4d5bd8ee0ae050dc333c0b2cf5b3c4be06875a08ea9b6bfa1c3479f755b0d44c255facc7c6cafec76d094714ed74e8bb94ac137fe302b22f29ac12e9477e5bb0

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.3'
-  s.date        = '2021-01-11'
+  s.version     = '2.0.4'
+  s.date        = '2021-04-02'
   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/data_privacy.rb

@@ -0,0 +1,19 @@
+module Klaviyo
+  class DataPrivacy < Client
+    DATA_PRIVACY = 'data-privacy'
+    DELETION_REQUEST = 'deletion-request'
+    
+    # Submits a data privacy-related deletion request
+    # @param id_type [String] 'email' or 'phone_number' or 'person_id
+    # @param identifier [String] value for the identifier specified
+    # @return a dictionary with a confirmation that deletion task submitted for the customer
+    def self.request_profile_deletion(id_type, identifier)
+      unless ['email', 'phone_number', 'person_id'].include? id_type
+        raise Klaviyo::KlaviyoError.new(INVALID_ID_TYPE_ERROR)
+      end
+      identifier = { id_type => identifier }      
+      path = "#{DATA_PRIVACY}/#{DELETION_REQUEST}"
+      v2_request(HTTP_POST, path, identifier)
+    end
+  end
+end

data/lib/klaviyo/apis/profiles.rb

@@ -1,6 +1,20 @@
 module Klaviyo
   class Profiles < Client
     PERSON = 'person'
+    PEOPLE = 'people'
+    SEARCH = 'search'
+
+    # Retrieves the id of the profile given email
+    # @param email [String] the email of the profile
+    # @return [JSON] a JSON object containing id of the profile
+    def self.get_profile_id_by_email(email)
+      path = "#{PEOPLE}/#{SEARCH}"
+      params = {
+        :email => email
+      }
+      v2_request(HTTP_GET, path, params)
+    end    
+
 
     # Retrieve all the data attributes for a Klaviyo Person ID.
     # @param person_id [String] the id of the profile

data/lib/klaviyo/klaviyo_module.rb

@@ -9,6 +9,7 @@ require_relative 'apis/lists'
 require_relative 'apis/metrics'
 require_relative 'apis/profiles'
 require_relative 'apis/campaigns'
+require_relative 'apis/data_privacy'
 
 module Klaviyo
   class << self
@@ -21,4 +22,5 @@ module Klaviyo
   NO_PRIVATE_API_KEY_ERROR = 'Please provide your Private API key for this request'
   NO_PUBLIC_API_KEY_ERROR = 'Please provide your Public API key for this request'
   REQUIRED_ARG_ERROR = 'You must identify a user by email, ID or phone_number'
+  INVALID_ID_TYPE_ERROR = 'Invalid id_type provided, must be one of: email, phone_number, person_id'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -75,6 +75,7 @@ files:
 - klaviyo.gemspec
 - lib/klaviyo.rb
 - lib/klaviyo/apis/campaigns.rb
+- lib/klaviyo/apis/data_privacy.rb
 - lib/klaviyo/apis/lists.rb
 - lib/klaviyo/apis/metrics.rb
 - lib/klaviyo/apis/profiles.rb