Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance

Defined in:

lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #address_requirements ⇒ AddressRequirement
• #address_sid ⇒ String

  The SID of the Address resource associated with the phone number.

• #api_version ⇒ String

  The API version used to start a new TwiML session.

• #assigned_add_ons ⇒ assigned_add_ons

  Access the assigned_add_ons.

• #beta ⇒ Boolean

  Whether the phone number is new to the Twilio platform.

• #bundle_sid ⇒ String

  The SID of the Bundle resource that you associate with the phone number.

• #capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities
• #context ⇒ IncomingPhoneNumberContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #delete ⇒ Boolean

  Delete the IncomingPhoneNumberInstance.

• #emergency_address_sid ⇒ String

  The SID of the emergency address configuration that we use for emergency calling from this phone number.

• #emergency_address_status ⇒ EmergencyAddressStatus
• #emergency_status ⇒ EmergencyStatus
• #fetch ⇒ IncomingPhoneNumberInstance

  Fetch the IncomingPhoneNumberInstance.

• #friendly_name ⇒ String

  The string that you assigned to describe the resource.

• #identity_sid ⇒ String

  The SID of the Identity resource that we associate with the phone number.

• #initialize(version, payload, account_sid: nil, sid: nil) ⇒ IncomingPhoneNumberInstance constructor

  Initialize the IncomingPhoneNumberInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #origin ⇒ String

  The phone number’s origin.

• #phone_number ⇒ String

  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.

• #sid ⇒ String

  The unique string that that we created to identify this IncomingPhoneNumber resource.

• #sms_application_sid ⇒ String

  The SID of the application that handles SMS messages sent to the phone number.

• #sms_fallback_method ⇒ String

  The HTTP method we use to call ‘sms_fallback_url`.

• #sms_fallback_url ⇒ String

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

• #sms_method ⇒ String

  The HTTP method we use to call ‘sms_url`.

• #sms_url ⇒ String

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

• #status ⇒ String
• #status_callback ⇒ String

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

• #status_callback_method ⇒ String

  The HTTP method we use to call ‘status_callback`.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #trunk_sid ⇒ String

  The SID of the Trunk that handles calls to the phone number.

• #update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset) ⇒ IncomingPhoneNumberInstance

  Update the IncomingPhoneNumberInstance.

• #uri ⇒ String

  The URI of the resource, relative to ‘api.twilio.com`.

• #voice_application_sid ⇒ String

  The SID of the application that handles calls to the phone number.

• #voice_caller_id_lookup ⇒ Boolean

  Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up).

• #voice_fallback_method ⇒ String

  The HTTP method we use to call ‘voice_fallback_url`.

• #voice_fallback_url ⇒ String

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

• #voice_method ⇒ String

  The HTTP method we use to call ‘voice_url`.

• #voice_receive_mode ⇒ VoiceReceiveMode
• #voice_url ⇒ String

  The URL we call when the phone number receives a call.

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ IncomingPhoneNumberInstance

Initialize the IncomingPhoneNumberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 473

def initialize(version, payload , account_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'address_sid' => payload['address_sid'],
        'address_requirements' => payload['address_requirements'],
        'api_version' => payload['api_version'],
        'beta' => payload['beta'],
        'capabilities' => payload['capabilities'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'friendly_name' => payload['friendly_name'],
        'identity_sid' => payload['identity_sid'],
        'phone_number' => payload['phone_number'],
        'origin' => payload['origin'],
        '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'],
        'uri' => payload['uri'],
        'voice_receive_mode' => payload['voice_receive_mode'],
        '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'],
        'emergency_status' => payload['emergency_status'],
        'emergency_address_sid' => payload['emergency_address_sid'],
        'emergency_address_status' => payload['emergency_address_status'],
        'bundle_sid' => payload['bundle_sid'],
        'status' => payload['status'],
    }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 532

def account_sid
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 544

def address_requirements
    @properties['address_requirements']
end

#address_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 538

def address_sid
    @properties['address_sid']
end

#api_version ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 550

def api_version
    @properties['api_version']
end

#assigned_add_ons ⇒ assigned_add_ons

Access the assigned_add_ons

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 832

def assigned_add_ons
    context.assigned_add_ons
end

#beta ⇒ Boolean

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 556

def beta
    @properties['beta']
end

#bundle_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 724

def bundle_sid
    @properties['bundle_sid']
end

#capabilities ⇒ ApiV2010AccountIncomingPhoneNumberCapabilities

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 562

def capabilities
    @properties['capabilities']
end

#context ⇒ IncomingPhoneNumberContext

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

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 523

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 568

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 574

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the IncomingPhoneNumberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 737

def delete

    context.delete
end

#emergency_address_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 712

def emergency_address_sid
    @properties['emergency_address_sid']
end

#emergency_address_status ⇒ EmergencyAddressStatus

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 718

def emergency_address_status
    @properties['emergency_address_status']
end

#emergency_status ⇒ EmergencyStatus

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 706

def emergency_status
    @properties['emergency_status']
end

#fetch ⇒ IncomingPhoneNumberInstance

Fetch the IncomingPhoneNumberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 745

def fetch

    context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 580

def friendly_name
    @properties['friendly_name']
end

#identity_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 586

def identity_sid
    @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 845

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

#origin ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 598

def origin
    @properties['origin']
end

#phone_number ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 592

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 604

def sid
    @properties['sid']
end

#sms_application_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 610

def sms_application_sid
    @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 616

def sms_fallback_method
    @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 622

def sms_fallback_url
    @properties['sms_fallback_url']
end

#sms_method ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 628

def sms_method
    @properties['sms_method']
end

#sms_url ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 634

def sms_url
    @properties['sms_url']
end

#status ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 730

def status
    @properties['status']
end

#status_callback ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 640

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 646

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 838

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

#trunk_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 652

def trunk_sid
    @properties['trunk_sid']
end

#update(account_sid: :unset, api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, voice_receive_mode: :unset, identity_sid: :unset, address_sid: :unset, bundle_sid: :unset) ⇒ IncomingPhoneNumberInstance

Update the IncomingPhoneNumberInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 776

def update(
    account_sid: :unset, 
    api_version: :unset, 
    friendly_name: :unset, 
    sms_application_sid: :unset, 
    sms_fallback_method: :unset, 
    sms_fallback_url: :unset, 
    sms_method: :unset, 
    sms_url: :unset, 
    status_callback: :unset, 
    status_callback_method: :unset, 
    voice_application_sid: :unset, 
    voice_caller_id_lookup: :unset, 
    voice_fallback_method: :unset, 
    voice_fallback_url: :unset, 
    voice_method: :unset, 
    voice_url: :unset, 
    emergency_status: :unset, 
    emergency_address_sid: :unset, 
    trunk_sid: :unset, 
    voice_receive_mode: :unset, 
    identity_sid: :unset, 
    address_sid: :unset, 
    bundle_sid: :unset
)

    context.update(
        account_sid: account_sid, 
        api_version: api_version, 
        friendly_name: friendly_name, 
        sms_application_sid: sms_application_sid, 
        sms_fallback_method: sms_fallback_method, 
        sms_fallback_url: sms_fallback_url, 
        sms_method: sms_method, 
        sms_url: sms_url, 
        status_callback: status_callback, 
        status_callback_method: status_callback_method, 
        voice_application_sid: voice_application_sid, 
        voice_caller_id_lookup: voice_caller_id_lookup, 
        voice_fallback_method: voice_fallback_method, 
        voice_fallback_url: voice_fallback_url, 
        voice_method: voice_method, 
        voice_url: voice_url, 
        emergency_status: emergency_status, 
        emergency_address_sid: emergency_address_sid, 
        trunk_sid: trunk_sid, 
        voice_receive_mode: voice_receive_mode, 
        identity_sid: identity_sid, 
        address_sid: address_sid, 
        bundle_sid: bundle_sid, 
    )
end

#uri ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 658

def uri
    @properties['uri']
end

#voice_application_sid ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 670

def voice_application_sid
    @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 676

def voice_caller_id_lookup
    @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 682

def voice_fallback_method
    @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 688

def voice_fallback_url
    @properties['voice_fallback_url']
end

#voice_method ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 694

def voice_method
    @properties['voice_method']
end

#voice_receive_mode ⇒ VoiceReceiveMode

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 664

def voice_receive_mode
    @properties['voice_receive_mode']
end

#voice_url ⇒ String

# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 700

def voice_url
    @properties['voice_url']
end