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 SID of the Account that created this IpAddress resource.

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

    The SID of the Call resource to fetch.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 288

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'] == nil ? payload['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  || @properties['ip_access_control_list_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:

  • (String) —

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



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

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.



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

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:



313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 313

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](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



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

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](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the IpAddressInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ IpAddressInstance

Fetch the IpAddressInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

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

Returns:

  • (String) —

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



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



418
419
420
421
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 418

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

#ip_access_control_list_sid ⇒ String

Returns The unique id of the IpAccessControlList resource that includes this resource.

Returns:

  • (String) —

    The unique id of the IpAccessControlList resource that includes this resource.



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

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.



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

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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) —

    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:



396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 396

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:

  • (String) —

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



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

def uri
    @properties['uri']
end