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/api/rest/account) responsible for this resource.

  • ip_access_control_list_sid (String) —

    The IpAccessControlList Sid that identifies the IpAddress resources to fetch.

  • sid (String) —

    A 34 character string that uniquely identifies the IpAddress resource to fetch.



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 201

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

Deletes the IpAddressInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



270
271
272
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 270

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

#fetch ⇒ IpAddressInstance

Fetch a IpAddressInstance

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 216

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  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



283
284
285
286
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 283

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

#to_s ⇒ Object

Provide a user friendly representation



276
277
278
279
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 276

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 64 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:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 245

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