Class: Telnyx::Internal::DefaultFlatPaginationTopLevelArray

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

Overview

Examples:

if default_flat_pagination_top_level_array.has_next?
  default_flat_pagination_top_level_array = default_flat_pagination_top_level_array.next_page
end
default_flat_pagination_top_level_array.auto_paging_each do |mcp_server|
  puts(mcp_server)
end

Instance Method Summary collapse

Methods included from Type::BasePage

#to_enum

Constructor Details

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

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 DefaultFlatPaginationTopLevelArray.

Parameters:



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

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

  case page_data
  in Array
    replace(page_data.map { Telnyx::Internal::Type::Converter.coerce(@model, _1) })
  else
  end
end

Instance Method Details

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

Parameters:

  • blk (Proc)

Yield Parameters:

  • (generic<Elem>) 


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

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

  page = self
  loop do
    page.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) 


82
83
84
85
86
 
# File 'lib/telnyx/internal/default_flat_pagination_top_level_array.rb', line 82

def inspect
  model = Telnyx::Internal::Type::Converter.inspect(@model, depth: 1)

  "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
end

#next_page ⇒ self

Returns:

  • (self)

Raises:

  • (Telnyx::HTTP::Error) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/telnyx/internal/default_flat_pagination_top_level_array.rb', line 26

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_number: @req.fetch(:query).fetch(
          :page_number,
          1
        ).to_i.succ
      }
    }
  )
  @client.request(req)
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


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

def next_page?
  !empty?
end