klaviyo_api 1.1.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee210f438b85ede58fe39263f07764a74a8622765ad4e33b47b0d50342d1b7c
-  data.tar.gz: 7be9072eb306d95cec9e8f071e2f660603ac10eba0ac91bf89bad25ad1500145
+  metadata.gz: 74537aa6edf57066528bfcefcf4fcb883ed5e85f68ed3bf562892dad33913d7d
+  data.tar.gz: a885389e5301c6377a244a8a78af4c25b70981859f789cd4e53e2d72f69b8fe7
 SHA512:
-  metadata.gz: 5294c67711fd37fe2bef0a2ffa542b28fc2e96ed28884bf0d843411423fd20a810f9ad8f988022c9eb7377b4f01806eec2ce0035f8a00b4448ad1c83d2cb2270
-  data.tar.gz: 04a24d63f8da7c9cbe735b43bc550b6650b0e75c211e09113b7d816a57b5ee9ca07b1ce581cbd11fc46d99e3cdf9ccd01eaafbe8373fd50fdf6084421807c723
+  metadata.gz: cd11a8738de6446e4d3619a1b703528021dbcd07328ceb3d01d3f335fff14bc3a21409995423b2f15f3356adb9a2a3a6702cf9db89549f2f59b59cbfefa91466
+  data.tar.gz: 6a4c7bf744142bed009aa223e297b19f15d5073a57faaa123def8304b75d9e415ad85fd86e7e10eb59027148c750adbdc6cc452944dc89eba8c95432aac9fafc

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## [1.2.0]
+
+### Added
+
+ - Support `/v2/list/<id>/members`
+ - Support `/v2/group/<id>/members/all` through `KlaviyoAPI::List#members`
+
 ## [1.0.0]
 
 ### Added

data/lib/klaviyo_api/resources/base.rb

@@ -34,8 +34,10 @@ module KlaviyoAPI
       def element_path(id, prefix_options = {}, query_options = nil)
         check_prefix_options(prefix_options)
 
+        id = URI.parser.escape id.to_s
         prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-        "#{prefix(prefix_options)}#{element_name}/#{URI.parser.escape id.to_s}#{format_extension}#{query_string(query_options)}"
+
+        "#{prefix(prefix_options)}#{element_name}#{'/' + id if id.present?}#{format_extension}#{query_string(query_options)}"
       end
     end
 

data/lib/klaviyo_api/resources/list.rb

@@ -12,5 +12,32 @@ module KlaviyoAPI
         super.tap { |record| record.id = scope }
       end
     end
+
+    # Gets all Members of this List. Uses the Groups endpoint.
+    # Returns an enumerator that knows how to transparently deal
+    # with Klaviyo's `marker` for pagination. Pages seem to be
+    # 1000 items.
+    #
+    # https://www.klaviyo.com/docs/api/v2/lists#get-members-all
+    def members(options = {})
+      CachingEnumerator.new do |yielder|
+        marker = nil
+
+        loop do
+          path = "#{self.class.prefix}group/#{id}/members/all"
+          path += "?marker=#{marker}" if marker
+
+          response = JSON.parse(connection.get(path, self.class.headers).body)
+          marker = response['marker']
+          list_members = response['records']
+
+          list_members.each do |list_member|
+            yielder.yield KlaviyoAPI::ListMember.new list_member
+          end
+
+          break if marker.nil?
+        end
+      end
+    end
   end
 end

data/lib/klaviyo_api/resources/list_member.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class ListMember < Base
+    self.prefix += 'v2/list/:list_id/'
+    self.primary_key = :id
+
+    # This is always plural
+    self.element_name = 'members'
+
+    class << self
+      # Removing a Member from a List is a DELETE call, but no ID is given.
+      # Instead, the email must be provided in the query params.
+      # Klaviyo also accepts an array in the body, but Ruby's HTTP library
+      # does not support DELETE bodies (as per the HTTP spec).
+      #
+      # https://www.klaviyo.com/docs/api/v2/lists#delete-members
+      def delete(email, options = {})
+        options = options.merge({emails: email})
+        connection.delete(element_path('', options), headers)
+      end
+
+      # A shortcut to create multiple ListMembers at once, as supported
+      # by the Klaviyo API.
+      #
+      # https://www.klaviyo.com/docs/api/v2/lists#post-members
+      def bulk_create(list_members, options = {})
+        payload = { profiles: list_members }.to_json
+
+        saved_list_members = []
+        connection.post(collection_path(options), payload, headers).tap do |response|
+          list_members_json = JSON.parse(response.body)
+          list_members_json.each do |list_member_json|
+            saved_list_members << KlaviyoAPI::ListMember.new(list_member_json)
+          end
+        end
+        saved_list_members
+      end
+    end
+
+    # Adding a single Member to a List does not exist - they must be added as an
+    # array of Profiles. In order to fit AR, we need to wrap self in an array,
+    # and remove it in the response.
+    #
+    # https://www.klaviyo.com/docs/api/v2/lists#post-members
+    def create
+      payload = { profiles: [self] }.to_json
+
+      run_callbacks :create do
+        connection.post(collection_path, payload, self.class.headers).tap do |response|
+          response.body = JSON.parse(response.body)[0].to_json
+          self.id = id_from_response(response)
+          load_attributes_from_response(response)
+        end
+      end
+    end
+
+    # Can only delete by email, not ID.
+    #
+    # https://www.klaviyo.com/docs/api/v2/lists#delete-members
+    def destroy
+      run_callbacks :destroy do
+        KlaviyoAPI::ListMember.delete self.email, prefix_options
+      end
+    end
+
+    def update
+      raise KlaviyoAPI::InvalidOperation.new 'Cannot update list members. You might be looking for delete and/or create.'
+    end
+  end
+end

data/lib/klaviyo_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KlaviyoAPI
-  VERSION = '1.1.9'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo_api
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.2.0
 platform: ruby
 authors:
 - rewind.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -212,6 +212,7 @@ files:
 - lib/klaviyo_api/resources.rb
 - lib/klaviyo_api/resources/base.rb
 - lib/klaviyo_api/resources/list.rb
+- lib/klaviyo_api/resources/list_member.rb
 - lib/klaviyo_api/session.rb
 - lib/klaviyo_api/version.rb
 homepage: https://github.com/rewindio/klaviyo_api.git