Class: Telnyx::Internal::PerPagePaginationV2

Inherits:
Object
  • Object
show all
Includes:
Type::BasePage
Defined in:
lib/telnyx/internal/per_page_pagination_v2.rb

Overview

Examples:

if per_page_pagination_v2.has_next?
  per_page_pagination_v2 = per_page_pagination_v2.next_page
end
per_page_pagination_v2.auto_paging_each do |brand|
  puts(brand)
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Type::BasePage

#to_enum

Constructor Details

#initialize(client:, req:, headers:, page_data:) ⇒ PerPagePaginationV2

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of PerPagePaginationV2.

Parameters:



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 68

def initialize(client:, req:, headers:, page_data:)
  super

  case page_data
  in {records: Array => records}
    @records = records.map { Telnyx::Internal::Type::Converter.coerce(@model, _1) }
  else
  end
  @page = page_data[:page]
  @total_records = page_data[:totalRecords]
end

Instance Attribute Details

#page ⇒ Integer

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 23

def page
  @page
end

#records ⇒ Array<generic<Elem>>?

Returns:

  • (Array<generic<Elem>>, nil) 


20
21
22
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 20

def records
  @records
end

#total_records ⇒ Integer

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 26

def total_records
  @total_records
end

Instance Method Details

#auto_paging_each(&blk) {|| ... } ⇒ Object

Parameters:

  • blk (Proc)

Yield Parameters:

  • (generic<Elem>) 


48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 48

def auto_paging_each(&blk)
  unless block_given?
    raise ArgumentError.new("A block must be given to ##{__method__}")
  end

  page = self
  loop do
    page.records&.each(&blk)

    break unless page.next_page?
    page = page.next_page
  end
end

#inspect ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 


83
84
85
86
87
88
89
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 83

def inspect
  # rubocop:disable Layout/LineLength
  model = Telnyx::Internal::Type::Converter.inspect(@model, depth: 1)

  "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} page=#{page.inspect} total_records=#{total_records.inspect}>"
  # rubocop:enable Layout/LineLength
end

#next_page ⇒ self

Returns:

  • (self)

Raises:

  • (Telnyx::HTTP::Error) 


35
36
37
38
39
40
41
42
43
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 35

def next_page
  unless next_page?
    message = "No more pages available. Please check #next_page? before calling ##{__method__}"
    raise RuntimeError.new(message)
  end

  req = Telnyx::Internal::Util.deep_merge(@req, {query: {page: (page || 1).to_i.succ}})
  @client.request(req)
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/telnyx/internal/per_page_pagination_v2.rb', line 29

def next_page?
  !records.to_a.empty? && (page.nil? || total_records.nil? || page < total_records)
end