class Twilio::REST::Supersim::V1::NetworkAccessProfileList

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Public Class Methods

new(version) click to toggle source

Initialize the NetworkAccessProfileList @param [Version] version Version that contains the resource @return [NetworkAccessProfileList] NetworkAccessProfileList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
20 def initialize(version)
21   super(version)
22 
23   # Path Solution
24   @solution = {}
25   @uri = "/NetworkAccessProfiles"
26 end

Public Instance Methods

create(unique_name: :unset, networks: :unset) click to toggle source

Create the NetworkAccessProfileInstance @param [String] unique_name An application-defined string that uniquely

identifies the resource. It can be used in place of the resource's `sid` in the
URL to address the resource.

@param [Array] networks List of Network SIDs that this Network Access

Profile will allow connections to.

@return [NetworkAccessProfileInstance] Created NetworkAccessProfileInstance

   # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
36 def create(unique_name: :unset, networks: :unset)
37   data = Twilio::Values.of({
38       'UniqueName' => unique_name,
39       'Networks' => Twilio.serialize_list(networks) { |e| e },
40   })
41 
42   payload = @version.create('POST', @uri, data: data)
43 
44   NetworkAccessProfileInstance.new(@version, payload, )
45 end
each() { |x| ... } click to toggle source

When passed a block, yields NetworkAccessProfileInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.

   # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
85 def each
86   limits = @version.read_limits
87 
88   page = self.page(page_size: limits[:page_size], )
89 
90   @version.stream(page,
91                   limit: limits[:limit],
92                   page_limit: limits[:page_limit]).each {|x| yield x}
93 end
get_page(target_url) click to toggle source

Retrieve a single page of NetworkAccessProfileInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of NetworkAccessProfileInstance

    # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
119 def get_page(target_url)
120   response = @version.domain.request(
121       'GET',
122       target_url
123   )
124   NetworkAccessProfilePage.new(@version, response, @solution)
125 end
list(limit: nil, page_size: nil) click to toggle source

Lists NetworkAccessProfileInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records.  If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
58 def list(limit: nil, page_size: nil)
59   self.stream(limit: limit, page_size: page_size).entries
60 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of NetworkAccessProfileInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of NetworkAccessProfileInstance

    # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
102 def page(page_token: :unset, page_number: :unset, page_size: :unset)
103   params = Twilio::Values.of({
104       'PageToken' => page_token,
105       'Page' => page_number,
106       'PageSize' => page_size,
107   })
108 
109   response = @version.page('GET', @uri, params: params)
110 
111   NetworkAccessProfilePage.new(@version, response, @solution)
112 end
stream(limit: nil, page_size: nil) click to toggle source

Streams NetworkAccessProfileInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
73 def stream(limit: nil, page_size: nil)
74   limits = @version.read_limits(limit, page_size)
75 
76   page = self.page(page_size: limits[:page_size], )
77 
78   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
79 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
129 def to_s
130   '#<Twilio.Supersim.V1.NetworkAccessProfileList>'
131 end