class Twilio::REST::Voice::V1::IpRecordList
Public Class Methods
Initialize the IpRecordList
@param [Version] version Version
that contains the resource @return [IpRecordList] IpRecordList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/voice/v1/ip_record.rb 18 def initialize(version) 19 super(version) 20 21 # Path Solution 22 @solution = {} 23 @uri = "/IpRecords" 24 end
Public Instance Methods
Create the IpRecordInstance
@param [String] ip_address An IP address in dotted decimal notation, IPv4 only. @param [String] friendly_name A descriptive string that you create to describe
the resource. It is not unique and can be up to 255 characters long.
@param [String] cidr_prefix_length An integer representing the length of the
{CIDR}[https://tools.ietf.org/html/rfc4632] prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.
@return [IpRecordInstance] Created IpRecordInstance
# File lib/twilio-ruby/rest/voice/v1/ip_record.rb 35 def create(ip_address: nil, friendly_name: :unset, cidr_prefix_length: :unset) 36 data = Twilio::Values.of({ 37 'IpAddress' => ip_address, 38 'FriendlyName' => friendly_name, 39 'CidrPrefixLength' => cidr_prefix_length, 40 }) 41 42 payload = @version.create('POST', @uri, data: data) 43 44 IpRecordInstance.new(@version, payload, ) 45 end
When passed a block, yields IpRecordInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/voice/v1/ip_record.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
Retrieve a single page of IpRecordInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of IpRecordInstance
# File lib/twilio-ruby/rest/voice/v1/ip_record.rb 119 def get_page(target_url) 120 response = @version.domain.request( 121 'GET', 122 target_url 123 ) 124 IpRecordPage.new(@version, response, @solution) 125 end
Lists IpRecordInstance
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/voice/v1/ip_record.rb 58 def list(limit: nil, page_size: nil) 59 self.stream(limit: limit, page_size: page_size).entries 60 end
Retrieve a single page of IpRecordInstance
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 IpRecordInstance
# File lib/twilio-ruby/rest/voice/v1/ip_record.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 IpRecordPage.new(@version, response, @solution) 112 end
Streams IpRecordInstance
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/voice/v1/ip_record.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
Provide a user friendly representation
# File lib/twilio-ruby/rest/voice/v1/ip_record.rb 129 def to_s 130 '#<Twilio.Voice.V1.IpRecordList>' 131 end