class KlaviyoAPI::List

Public Class Methods

find_single(scope, options) click to toggle source

Override this from ActiveResource#base in order to inject the id into the response because it's not returned

Calls superclass method
# File lib/klaviyo_api/resources/list.rb, line 13
def find_single(scope, options)
  super.tap { |record| record.id = scope }
end

Public Instance Methods

members(options = {}) click to toggle source

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.

www.klaviyo.com/docs/api/v2/lists#get-members-all

# File lib/klaviyo_api/resources/list.rb, line 24
def members(options = {})
  KlaviyoAPI::ListMember.all_members params: { list_id: id, **options }
end