class Stripe::ListObject
Constants
- OBJECT_NAME
Attributes
This accessor allows a `ListObject` to inherit various filters that were given to a predecessor. This allows for things like consistent limits, expansions, and predicates as a user pages through resources.
Public Class Methods
An empty list object. This is returned from next
when we know that there isn't a next page in order to replicate the behavior of the API when it attempts to return a page beyond the last.
# File lib/stripe/list_object.rb, line 20 def self.empty_list(opts = {}) ListObject.construct_from({ data: [] }, opts) end
# File lib/stripe/list_object.rb, line 24 def initialize(*args) super self.filters = {} end
Public Instance Methods
# File lib/stripe/list_object.rb, line 29 def [](key) case key when String, Symbol super else raise ArgumentError, "You tried to access the #{key.inspect} index, but ListObject " \ "types only support String keys. (HINT: List calls return an " \ "object with a 'data' (which is the data array). You likely " \ "want to call #data[#{key.inspect}])" end end
Iterates through each resource in all pages, making additional fetches to the API as necessary.
The default iteration direction is forwards according to Stripe's API “natural” ordering direction – newer objects first, and moving towards older objects.
However, if the initial list object was fetched using an `ending_before` cursor (and only `ending_before`, `starting_after` cannot also be included), the method assumes that the user is trying to iterate backwards compared to natural ordering and returns results that way – older objects first, and moving towards newer objects.
Note that this method will make as many API calls as necessary to fetch all resources. For more granular control, please see each
and next_page
.
# File lib/stripe/list_object.rb, line 67 def auto_paging_each(&blk) return enum_for(:auto_paging_each) unless block_given? page = self loop do # Backward iterating activates if we have an `ending_before` constraint # and _just_ an `ending_before` constraint. If `starting_after` was # also used, we iterate forwards normally. if filters.include?(:ending_before) && !filters.include?(:starting_after) page.reverse_each(&blk) page = page.previous_page else page.each(&blk) page = page.next_page end break if page.empty? end end
Iterates through each resource in the page represented by the current `ListObject`.
Note that this method makes no effort to fetch a new page when it gets to the end of the current page's resources. See also auto_paging_each
.
# File lib/stripe/list_object.rb, line 47 def each(&blk) data.each(&blk) end
Returns true if the page object contains no elements.
# File lib/stripe/list_object.rb, line 89 def empty? data.empty? end
Fetches the next page in the resource list (if there is one).
This method will try to respect the limit of the current page. If none was given, the default limit will be fetched again.
# File lib/stripe/list_object.rb, line 104 def next_page(params = {}, opts = {}) return self.class.empty_list(opts) unless has_more last_id = data.last.id params = filters.merge(starting_after: last_id).merge(params) list(params, opts) end
Fetches the previous page in the resource list (if there is one).
This method will try to respect the limit of the current page. If none was given, the default limit will be fetched again.
# File lib/stripe/list_object.rb, line 118 def previous_page(params = {}, opts = {}) return self.class.empty_list(opts) unless has_more first_id = data.first.id params = filters.merge(ending_before: first_id).merge(params) list(params, opts) end
# File lib/stripe/list_object.rb, line 128 def resource_url url || raise(ArgumentError, "List object does not contain a 'url' field.") end
# File lib/stripe/list_object.rb, line 93 def retrieve(id, opts = {}) id, retrieve_params = Util.normalize_id(id) url = "#{resource_url}/#{CGI.escape(id)}" resp, opts = execute_resource_request(:get, url, retrieve_params, opts) Util.convert_to_stripe_object(resp.data, opts) end
Iterates through each resource in the page represented by the current `ListObject` in reverse.
# File lib/stripe/list_object.rb, line 135 def reverse_each(&blk) data.reverse_each(&blk) end