Class: Twilio::REST::Voice::V1::SourceIpMappingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SourceIpMappingList

Initialize the SourceIpMappingList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/SourceIpMappings"
    
end

Instance Method Details

#create(ip_record_sid: nil, sip_domain_sid: nil) ⇒ SourceIpMappingInstance

Create the SourceIpMappingInstance

Parameters:

  • ip_record_sid (String) (defaults to: nil) —

    The Twilio-provided string that uniquely identifies the IP Record resource to map from.

  • sip_domain_sid (String) (defaults to: nil) —

    The SID of the SIP Domain that the IP Record should be mapped to.

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 39

def create(
  ip_record_sid: nil, 
  sip_domain_sid: nil
)

    data = Twilio::Values.of({
        'IpRecordSid' => ip_record_sid,
        'SipDomainSid' => sip_domain_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    SourceIpMappingInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(ip_record_sid: nil, sip_domain_sid: nil) ⇒ SourceIpMappingInstance

Create the SourceIpMappingInstanceMetadata

Parameters:

  • ip_record_sid (String) (defaults to: nil) —

    The Twilio-provided string that uniquely identifies the IP Record resource to map from.

  • sip_domain_sid (String) (defaults to: nil) —

    The SID of the SIP Domain that the IP Record should be mapped to.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 67

def create_with_metadata(
  ip_record_sid: nil, 
  sip_domain_sid: nil
)

    data = Twilio::Values.of({
        'IpRecordSid' => ip_record_sid,
        'SipDomainSid' => sip_domain_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    source_ip_mapping_instance = SourceIpMappingInstance.new(
        @version,
        response.body,
    )
    SourceIpMappingInstanceMetadata.new(
        @version,
        source_ip_mapping_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 165

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of SourceIpMappingInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SourceIpMappingInstance



206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 206

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
SourceIpMappingPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists SourceIpMappingInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results



108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 108

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(limit: nil, page_size: nil) ⇒ Array

Lists SourceIpMappingPageMetadata records from the API as a list.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 148

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    SourceIpMappingPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of SourceIpMappingInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of SourceIpMappingInstance



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 186

def page(page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    SourceIpMappingPage.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.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 126

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



217
218
219
 
# File 'lib/twilio-ruby/rest/voice/v1/source_ip_mapping.rb', line 217

def to_s
    '#<Twilio.Voice.V1.SourceIpMappingList>'
end