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

Inherits:
InstanceResource
  • 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, payload, account_sid: nil, ip_access_control_list_sid: nil, sid: nil) ⇒ IpAddressInstance

Initialize the IpAddressInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique id of the Account that responsible for this resource.

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

    The ip_access_control_list_sid

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

    The sid



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 277

def initialize(version, payload, account_sid: nil, ip_access_control_list_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'ip_address' => payload['ip_address'],
      'cidr_prefix_length' => payload['cidr_prefix_length'].to_i,
      'ip_access_control_list_sid' => payload['ip_access_control_list_sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'uri' => payload['uri'],
  }

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'ip_access_control_list_sid' => ip_access_control_list_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account that responsible for this resource.

Returns:

  • (String) —

    The unique id of the Account that responsible for this resource.



326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 326

def 
  @properties['account_sid']
end

#cidr_prefix_length ⇒ String

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

  • (String) —

    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.



344
345
346
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 344

def cidr_prefix_length
  @properties['cidr_prefix_length']
end

#context ⇒ IpAddressContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 306

def context
  unless @instance_context
    @instance_context = IpAddressContext.new(
        @version,
        @params['account_sid'],
        @params['ip_access_control_list_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date that this resource was created, given as GMT in RFC 2822 format.

Returns:

  • (Time) —

    The date that this resource was created, given as GMT in RFC 2822 format.



356
357
358
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 356

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated, given as GMT in RFC 2822 format.

Returns:

  • (Time) —

    The date that this resource was last updated, given as GMT in RFC 2822 format.



362
363
364
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 362

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the IpAddressInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



396
397
398
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 396

def delete
  context.delete
end

#fetch ⇒ IpAddressInstance

Fetch a IpAddressInstance

Returns:



375
376
377
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 375

def fetch
  context.fetch
end

#friendly_name ⇒ String

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

Returns:

  • (String) —

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



332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 332

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



409
410
411
412
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 409

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.IpAddressInstance #{values}>"
end

#ip_access_control_list_sid ⇒ String

Returns The ip_access_control_list_sid.

Returns:

  • (String) —

    The ip_access_control_list_sid



350
351
352
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 350

def ip_access_control_list_sid
  @properties['ip_access_control_list_sid']
end

#ip_address ⇒ String

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

Returns:

  • (String) —

    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.



338
339
340
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 338

def ip_address
  @properties['ip_address']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 320

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



402
403
404
405
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 402

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.IpAddressInstance #{values}>"
end

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

Update the IpAddressInstance

Parameters:

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

    The ip_address

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

    The friendly_name

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

    The cidr_prefix_length

Returns:



385
386
387
388
389
390
391
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 385

def update(ip_address: :unset, friendly_name: :unset, cidr_prefix_length: :unset)
  context.update(
      ip_address: ip_address,
      friendly_name: friendly_name,
      cidr_prefix_length: cidr_prefix_length,
  )
end

#uri ⇒ String

Returns The URI for this resource, relative to api.twilio.com.

Returns:



368
369
370
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 368

def uri
  @properties['uri']
end