class Twilio::REST::Voice::V1::SourceIpMappingList

Public Class Methods

new(version) click to toggle source

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

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

Public Instance Methods

create(ip_record_sid: nil, sip_domain_sid: nil) click to toggle source

Create the SourceIpMappingInstance @param [String] ip_record_sid The Twilio-provided string that uniquely

identifies the IP Record resource to map from.

@param [String] sip_domain_sid The SID of the SIP Domain that the IP Record

should be mapped to.

@return [SourceIpMappingInstance] Created SourceIpMappingInstance

   # File lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb
33 def create(ip_record_sid: nil, sip_domain_sid: nil)
34   data = Twilio::Values.of({'IpRecordSid' => ip_record_sid, 'SipDomainSid' => sip_domain_sid, })
35 
36   payload = @version.create('POST', @uri, data: data)
37 
38   SourceIpMappingInstance.new(@version, payload, )
39 end
each() { |x| ... } click to toggle source

When passed a block, yields SourceIpMappingInstance 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/source_ip_mapping.rb
79 def each
80   limits = @version.read_limits
81 
82   page = self.page(page_size: limits[:page_size], )
83 
84   @version.stream(page,
85                   limit: limits[:limit],
86                   page_limit: limits[:page_limit]).each {|x| yield x}
87 end
get_page(target_url) click to toggle source

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

    # File lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb
113 def get_page(target_url)
114   response = @version.domain.request(
115       'GET',
116       target_url
117   )
118   SourceIpMappingPage.new(@version, response, @solution)
119 end
list(limit: nil, page_size: nil) click to toggle source

Lists SourceIpMappingInstance 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/source_ip_mapping.rb
52 def list(limit: nil, page_size: nil)
53   self.stream(limit: limit, page_size: page_size).entries
54 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

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

    # File lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb
 96 def page(page_token: :unset, page_number: :unset, page_size: :unset)
 97   params = Twilio::Values.of({
 98       'PageToken' => page_token,
 99       'Page' => page_number,
100       'PageSize' => page_size,
101   })
102 
103   response = @version.page('GET', @uri, params: params)
104 
105   SourceIpMappingPage.new(@version, response, @solution)
106 end
stream(limit: nil, page_size: nil) click to toggle source

Streams SourceIpMappingInstance 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/source_ip_mapping.rb
67 def stream(limit: nil, page_size: nil)
68   limits = @version.read_limits(limit, page_size)
69 
70   page = self.page(page_size: limits[:page_size], )
71 
72   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
73 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb
123 def to_s
124   '#<Twilio.Voice.V1.SourceIpMappingList>'
125 end