Class: Twilio::REST::Voice::V1::IpRecordInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/voice/v1/ip_record.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ IpRecordInstance

Initialize the IpRecordInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this IpRecord resource.

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

    The SID of the Call resource to fetch.



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 541

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sid' => payload['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,
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the IP Record resource.

Returns:

  • (String) —

    The SID of the Account that created the IP Record resource.



575
576
577
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 575

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. By default the entire IP address is used, which for IPv4 is value 32.

Returns:

  • (String) —

    An integer representing the length of the CIDR prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.



599
600
601
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 599

def cidr_prefix_length
    @properties['cidr_prefix_length']
end

#context ⇒ IpRecordContext

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

Returns:



566
567
568
569
570
571
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 566

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in RFC 2822 format.

Returns:

  • (Time) —

    The date and time in GMT that the resource was created specified in RFC 2822 format.



605
606
607
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 605

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in RFC 2822 format.

Returns:

  • (Time) —

    The date and time in GMT that the resource was last updated specified in RFC 2822 format.



611
612
613
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 611

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the IpRecordInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



624
625
626
627
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 624

def delete

    context.delete
end

#fetch ⇒ IpRecordInstance

Fetch the IpRecordInstance

Returns:



632
633
634
635
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 632

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



587
588
589
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 587

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



659
660
661
662
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 659

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

#ip_address ⇒ String

Returns An IP address in dotted decimal notation, IPv4 only.

Returns:

  • (String) —

    An IP address in dotted decimal notation, IPv4 only.



593
594
595
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 593

def ip_address
    @properties['ip_address']
end

#sid ⇒ String

Returns The unique string that we created to identify the IP Record resource.

Returns:

  • (String) —

    The unique string that we created to identify the IP Record resource.



581
582
583
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 581

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



652
653
654
655
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 652

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

#update(friendly_name: :unset) ⇒ IpRecordInstance

Update the IpRecordInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

Returns:



641
642
643
644
645
646
647
648
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 641

def update(
  friendly_name: :unset
)

    context.update(
        friendly_name: friendly_name, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



617
618
619
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 617

def url
    @properties['url']
end