class Twilio::REST::Api::V2010::AccountContext::SipList::IpAccessControlListList

Public Class Methods

new(version, account_sid: nil) click to toggle source

Initialize the IpAccessControlListList @param [Version] version Version that contains the resource @param [String] account_sid A 34 character string that uniquely identifies this

resource.

@return [IpAccessControlListList] IpAccessControlListList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb
22 def initialize(version, account_sid: nil)
23   super(version)
24 
25   # Path Solution
26   @solution = {account_sid: account_sid}
27   @uri = "/Accounts/#{@solution[:account_sid]}/SIP/IpAccessControlLists.json"
28 end

Public Instance Methods

create(friendly_name: nil) click to toggle source

Create the IpAccessControlListInstance @param [String] friendly_name A human readable descriptive text that describes

the IpAccessControlList, up to 64 characters long.

@return [IpAccessControlListInstance] Created IpAccessControlListInstance

    # File lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb
115 def create(friendly_name: nil)
116   data = Twilio::Values.of({'FriendlyName' => friendly_name, })
117 
118   payload = @version.create('POST', @uri, data: data)
119 
120   IpAccessControlListInstance.new(@version, payload, account_sid: @solution[:account_sid], )
121 end
each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb
68 def each
69   limits = @version.read_limits
70 
71   page = self.page(page_size: limits[:page_size], )
72 
73   @version.stream(page,
74                   limit: limits[:limit],
75                   page_limit: limits[:page_limit]).each {|x| yield x}
76 end
get_page(target_url) click to toggle source

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

    # File lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb
102 def get_page(target_url)
103   response = @version.domain.request(
104       'GET',
105       target_url
106   )
107   IpAccessControlListPage.new(@version, response, @solution)
108 end
list(limit: nil, page_size: nil) click to toggle source

Lists IpAccessControlListInstance 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/api/v2010/account/sip/ip_access_control_list.rb
41 def list(limit: nil, page_size: nil)
42   self.stream(limit: limit, page_size: page_size).entries
43 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of IpAccessControlListInstance 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 IpAccessControlListInstance

   # File lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb
85 def page(page_token: :unset, page_number: :unset, page_size: :unset)
86   params = Twilio::Values.of({
87       'PageToken' => page_token,
88       'Page' => page_number,
89       'PageSize' => page_size,
90   })
91 
92   response = @version.page('GET', @uri, params: params)
93 
94   IpAccessControlListPage.new(@version, response, @solution)
95 end
stream(limit: nil, page_size: nil) click to toggle source

Streams IpAccessControlListInstance 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/api/v2010/account/sip/ip_access_control_list.rb
56 def stream(limit: nil, page_size: nil)
57   limits = @version.read_limits(limit, page_size)
58 
59   page = self.page(page_size: limits[:page_size], )
60 
61   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
62 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb
125 def to_s
126   '#<Twilio.Api.V2010.IpAccessControlListList>'
127 end