Class: Twilio::REST::Supersim::V1::NetworkAccessProfileList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Supersim::V1::NetworkAccessProfileList
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
Instance Method Summary collapse
-
#create(unique_name: :unset, networks: :unset) ⇒ NetworkAccessProfileInstance
Create the NetworkAccessProfileInstance.
-
#each ⇒ Object
When passed a block, yields NetworkAccessProfileInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of NetworkAccessProfileInstance records from the API.
-
#initialize(version) ⇒ NetworkAccessProfileList
constructor
Initialize the NetworkAccessProfileList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists NetworkAccessProfileInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of NetworkAccessProfileInstance records from the API.
-
#stream(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) ⇒ NetworkAccessProfileList
Initialize the NetworkAccessProfileList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/NetworkAccessProfiles" end |
Instance Method Details
#create(unique_name: :unset, networks: :unset) ⇒ NetworkAccessProfileInstance
Create the NetworkAccessProfileInstance
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 37 def create( unique_name: :unset, networks: :unset ) data = Twilio::Values.of({ 'UniqueName' => unique_name, 'Networks' => Twilio.serialize_list(networks) { |e| e }, }) payload = @version.create('POST', @uri, data: data) NetworkAccessProfileInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields NetworkAccessProfileInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
97 98 99 100 101 102 103 104 105 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 97 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 NetworkAccessProfileInstance records from the API. Request is executed immediately.
131 132 133 134 135 136 137 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 131 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) NetworkAccessProfilePage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists NetworkAccessProfileInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
66 67 68 69 70 71 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 66 def list(limit: nil, page_size: nil) self.stream( limit: limit, page_size: page_size ).entries end |
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of NetworkAccessProfileInstance records from the API. Request is executed immediately.
114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 114 def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) NetworkAccessProfilePage.new(@version, response, @solution) end |
#stream(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.
84 85 86 87 88 89 90 91 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 84 def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( 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
142 143 144 |
# File 'lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb', line 142 def to_s '#<Twilio.Supersim.V1.NetworkAccessProfileList>' end |