Class: Twilio::REST::Trunking::V1::TrunkContext::PhoneNumberInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, trunk_sid: nil, sid: nil) ⇒ PhoneNumberInstance

Initialize the PhoneNumberInstance

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 PhoneNumber resource.

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

    The SID of the Call resource to fetch.



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 470

def initialize(version, payload , trunk_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'address_requirements' => payload['address_requirements'],
        'api_version' => payload['api_version'],
        'beta' => payload['beta'],
        'capabilities' => payload['capabilities'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'friendly_name' => payload['friendly_name'],
        'links' => payload['links'],
        'phone_number' => payload['phone_number'],
        'sid' => payload['sid'],
        'sms_application_sid' => payload['sms_application_sid'],
        'sms_fallback_method' => payload['sms_fallback_method'],
        'sms_fallback_url' => payload['sms_fallback_url'],
        'sms_method' => payload['sms_method'],
        'sms_url' => payload['sms_url'],
        'status_callback' => payload['status_callback'],
        'status_callback_method' => payload['status_callback_method'],
        'trunk_sid' => payload['trunk_sid'],
        'url' => payload['url'],
        'voice_application_sid' => payload['voice_application_sid'],
        'voice_caller_id_lookup' => payload['voice_caller_id_lookup'],
        'voice_fallback_method' => payload['voice_fallback_method'],
        'voice_fallback_url' => payload['voice_fallback_url'],
        'voice_method' => payload['voice_method'],
        'voice_url' => payload['voice_url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource.

Returns:



522
523
524
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 522

def 
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

Returns:

  • (AddressRequirement) 


528
529
530
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 528

def address_requirements
    @properties['address_requirements']
end

#api_version ⇒ String

Returns The API version used to start a new TwiML session.

Returns:

  • (String) —

    The API version used to start a new TwiML session.



534
535
536
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 534

def api_version
    @properties['api_version']
end

#beta ⇒ Boolean

Returns Whether the phone number is new to the Twilio platform. Can be: true or false.

Returns:

  • (Boolean) —

    Whether the phone number is new to the Twilio platform. Can be: true or false.



540
541
542
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 540

def beta
    @properties['beta']
end

#capabilities ⇒ TrunkingV1TrunkPhoneNumberCapabilities

Returns:

  • (TrunkingV1TrunkPhoneNumberCapabilities) 


546
547
548
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 546

def capabilities
    @properties['capabilities']
end

#context ⇒ PhoneNumberContext

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

Returns:



513
514
515
516
517
518
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 513

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



552
553
554
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 552

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



558
559
560
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 558

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



679
680
681
682
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 679

def delete

    context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



687
688
689
690
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 687

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.



564
565
566
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 564

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



701
702
703
704
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 701

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



570
571
572
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 570

def links
    @properties['links']
end

#phone_number ⇒ String

Returns The phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.

Returns:



576
577
578
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 576

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

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

Returns:

  • (String) —

    The unique string that we created to identify the PhoneNumber resource.



582
583
584
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 582

def sid
    @properties['sid']
end

#sms_application_sid ⇒ String

Returns The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all ‘sms_*_url` values and use those of the application.

Returns:

  • (String) —

    The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all ‘sms_*_url` values and use those of the application.



588
589
590
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 588

def sms_application_sid
    @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

Returns The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call sms_fallback_url. Can be: GET or POST.



594
595
596
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 594

def sms_fallback_method
    @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The URL that we call using the sms_fallback_method when an error occurs while retrieving or executing the TwiML from sms_url.

Returns:

  • (String) —

    The URL that we call using the sms_fallback_method when an error occurs while retrieving or executing the TwiML from sms_url.



600
601
602
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 600

def sms_fallback_url
    @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The HTTP method we use to call sms_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call sms_url. Can be: GET or POST.



606
607
608
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 606

def sms_method
    @properties['sms_method']
end

#sms_url ⇒ String

Returns The URL we call using the sms_method when the phone number receives an incoming SMS message.

Returns:

  • (String) —

    The URL we call using the sms_method when the phone number receives an incoming SMS message.



612
613
614
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 612

def sms_url
    @properties['sms_url']
end

#status_callback ⇒ String

Returns The URL we call using the status_callback_method to send status information to your application.

Returns:

  • (String) —

    The URL we call using the status_callback_method to send status information to your application.



618
619
620
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 618

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method we use to call status_callback. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call status_callback. Can be: GET or POST.



624
625
626
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 624

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



694
695
696
697
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 694

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

#trunk_sid ⇒ String

Returns The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice URLs and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.

Returns:

  • (String) —

    The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice URLs and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.



630
631
632
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 630

def trunk_sid
    @properties['trunk_sid']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



636
637
638
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 636

def url
    @properties['url']
end

#voice_application_sid ⇒ String

Returns The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice URLs and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.

Returns:

  • (String) —

    The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice URLs and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.



642
643
644
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 642

def voice_application_sid
    @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

Returns Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.

Returns:

  • (Boolean) —

    Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.



648
649
650
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 648

def voice_caller_id_lookup
    @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns The HTTP method that we use to call voice_fallback_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method that we use to call voice_fallback_url. Can be: GET or POST.



654
655
656
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 654

def voice_fallback_method
    @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The URL that we call using the voice_fallback_method when an error occurs retrieving or executing the TwiML requested by url.

Returns:

  • (String) —

    The URL that we call using the voice_fallback_method when an error occurs retrieving or executing the TwiML requested by url.



660
661
662
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 660

def voice_fallback_url
    @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method we use to call voice_url. Can be: GET or POST.

Returns:

  • (String) —

    The HTTP method we use to call voice_url. Can be: GET or POST.



666
667
668
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 666

def voice_method
    @properties['voice_method']
end

#voice_url ⇒ String

Returns The URL we call using the voice_method when the phone number receives a call. The voice_url is not be used if a voice_application_sid or a trunk_sid is set.

Returns:

  • (String) —

    The URL we call using the voice_method when the phone number receives a call. The voice_url is not be used if a voice_application_sid or a trunk_sid is set.



672
673
674
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 672

def voice_url
    @properties['voice_url']
end