Class: Twilio::REST::Supersim::V1::NetworkList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Supersim::V1::NetworkList
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/network.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields NetworkInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of NetworkInstance records from the API.
-
#initialize(version) ⇒ NetworkList
constructor
Initialize the NetworkList.
-
#list(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) ⇒ Array
Lists NetworkInstance records from the API as a list.
-
#page(iso_country: :unset, mcc: :unset, mnc: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of NetworkInstance records from the API.
-
#stream(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ NetworkList
Initialize the NetworkList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/Networks" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields NetworkInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
87 88 89 90 91 92 93 94 95 |
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 87 def each limits = @version.read_limits page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]).each {|x| yield x} end |
#get_page(target_url) ⇒ Page
Retrieve a single page of NetworkInstance records from the API. Request is executed immediately.
127 128 129 130 131 132 133 |
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 127 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) NetworkPage.new(@version, response, @solution) end |
#list(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) ⇒ Array
Lists NetworkInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
47 48 49 50 51 52 53 54 55 |
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 47 def list(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) self.stream( iso_country: iso_country, mcc: mcc, mnc: mnc, limit: limit, page_size: page_size ).entries end |
#page(iso_country: :unset, mcc: :unset, mnc: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of NetworkInstance records from the API. Request is executed immediately.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 107 def page(iso_country: :unset, mcc: :unset, mnc: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'IsoCountry' => iso_country, 'Mcc' => mcc, 'Mnc' => mnc, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) NetworkPage.new(@version, response, @solution) end |
#stream(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 71 def stream(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( iso_country: iso_country, mcc: mcc, mnc: mnc, page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#to_s ⇒ Object
Provide a user friendly representation
138 139 140 |
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 138 def to_s '#<Twilio.Supersim.V1.NetworkList>' end |