Class: Twilio::REST::Api::V2010::AccountContext::SipList::IpAccessControlListContext::IpAddressContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, ip_access_control_list_sid, sid) ⇒ IpAddressContext

Initialize the IpAddressContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The unique id of the [Account](www.twilio.com/docs/iam/api/account) responsible for this resource.

  • ip_access_control_list_sid (String) —

    The IpAccessControlList Sid that identifies the IpAddress resources to update.

  • sid (String) —

    A 34 character string that identifies the IpAddress resource to update.



165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 165

def initialize(version, , ip_access_control_list_sid, sid)
    super(version)

    # Path Solution
    @solution = { account_sid: , ip_access_control_list_sid: ip_access_control_list_sid, sid: sid,  }
    @uri = "/Accounts/#{@solution[:account_sid]}/SIP/IpAccessControlLists/#{@solution[:ip_access_control_list_sid]}/IpAddresses/#{@solution[:sid]}.json"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the IpAddressInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



177
178
179
180
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 177

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ IpAddressInstance

Fetch the IpAddressInstance

Returns:



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 185

def fetch

    payload = @version.fetch('GET', @uri)
    IpAddressInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        ip_access_control_list_sid: @solution[:ip_access_control_list_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



235
236
237
238
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 235

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.IpAddressContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



228
229
230
231
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 228

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.IpAddressContext #{context}>"
end

#update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset) ⇒ IpAddressInstance

Update the IpAddressInstance

Parameters:

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

    An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.

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

    A human readable descriptive text for this resource, up to 255 characters long.

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

    An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.

Returns:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 203

def update(
    ip_address: :unset, 
    friendly_name: :unset, 
    cidr_prefix_length: :unset
)

    data = Twilio::Values.of({
        'IpAddress' => ip_address,
        'FriendlyName' => friendly_name,
        'CidrPrefixLength' => cidr_prefix_length,
    })

    payload = @version.update('POST', @uri, data: data)
    IpAddressInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        ip_access_control_list_sid: @solution[:ip_access_control_list_sid],
        sid: @solution[:sid],
    )
end