Class: Twilio::REST::Trunking::V1::TrunkContext::PhoneNumberInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Trunking::V1::TrunkContext::PhoneNumberInstance
- Defined in:
- lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource.
- #address_requirements ⇒ AddressRequirement
-
#api_version ⇒ String
The API version used to start a new TwiML session.
-
#beta ⇒ Boolean
Whether the phone number is new to the Twilio platform.
-
#capabilities ⇒ Hash
The set of Boolean properties that indicate whether a phone number can receive calls or messages.
-
#context ⇒ PhoneNumberContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the PhoneNumberInstance.
-
#fetch ⇒ PhoneNumberInstance
Fetch the PhoneNumberInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, trunk_sid: nil, sid: nil) ⇒ PhoneNumberInstance
constructor
Initialize the PhoneNumberInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of related resources.
-
#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 we created to identify the PhoneNumber 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 using the ‘sms_fallback_method` 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 using the ‘sms_method` when the phone number receives an incoming SMS message.
-
#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.
-
#url ⇒ String
The absolute URL of the resource.
-
#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 that we use to call ‘voice_fallback_url`.
-
#voice_fallback_url ⇒ String
The URL that we call using the ‘voice_fallback_method` 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_url ⇒ String
The URL we call using the ‘voice_method` when the phone number receives a call.
Constructor Details
#initialize(version, payload, trunk_sid: nil, sid: nil) ⇒ PhoneNumberInstance
Initialize the PhoneNumberInstance
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 244 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
295 296 297 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 295 def account_sid @properties['account_sid'] end |
#address_requirements ⇒ AddressRequirement
301 302 303 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 301 def address_requirements @properties['address_requirements'] end |
#api_version ⇒ String
307 308 309 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 307 def api_version @properties['api_version'] end |
#beta ⇒ Boolean
313 314 315 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 313 def beta @properties['beta'] end |
#capabilities ⇒ Hash
319 320 321 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 319 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
286 287 288 289 290 291 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 286 def context unless @instance_context @instance_context = PhoneNumberContext.new(@version , @params['trunk_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
325 326 327 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 325 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
331 332 333 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 331 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the PhoneNumberInstance
452 453 454 455 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 452 def delete context.delete end |
#fetch ⇒ PhoneNumberInstance
Fetch the PhoneNumberInstance
460 461 462 463 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 460 def fetch context.fetch end |
#friendly_name ⇒ String
337 338 339 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 337 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
474 475 476 477 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 474 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Trunking.V1.PhoneNumberInstance #{values}>" end |
#links ⇒ Hash
343 344 345 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 343 def links @properties['links'] end |
#phone_number ⇒ String
349 350 351 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 349 def phone_number @properties['phone_number'] end |
#sid ⇒ String
355 356 357 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 355 def sid @properties['sid'] end |
#sms_application_sid ⇒ String
361 362 363 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 361 def sms_application_sid @properties['sms_application_sid'] end |
#sms_fallback_method ⇒ String
367 368 369 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 367 def sms_fallback_method @properties['sms_fallback_method'] end |
#sms_fallback_url ⇒ String
373 374 375 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 373 def sms_fallback_url @properties['sms_fallback_url'] end |
#sms_method ⇒ String
379 380 381 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 379 def sms_method @properties['sms_method'] end |
#sms_url ⇒ String
385 386 387 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 385 def sms_url @properties['sms_url'] end |
#status_callback ⇒ String
391 392 393 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 391 def status_callback @properties['status_callback'] end |
#status_callback_method ⇒ String
397 398 399 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 397 def status_callback_method @properties['status_callback_method'] end |
#to_s ⇒ Object
Provide a user friendly representation
467 468 469 470 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 467 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Trunking.V1.PhoneNumberInstance #{values}>" end |
#trunk_sid ⇒ String
403 404 405 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 403 def trunk_sid @properties['trunk_sid'] end |
#url ⇒ String
409 410 411 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 409 def url @properties['url'] end |
#voice_application_sid ⇒ String
415 416 417 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 415 def voice_application_sid @properties['voice_application_sid'] end |
#voice_caller_id_lookup ⇒ Boolean
421 422 423 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 421 def voice_caller_id_lookup @properties['voice_caller_id_lookup'] end |
#voice_fallback_method ⇒ String
427 428 429 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 427 def voice_fallback_method @properties['voice_fallback_method'] end |
#voice_fallback_url ⇒ String
433 434 435 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 433 def voice_fallback_url @properties['voice_fallback_url'] end |
#voice_method ⇒ String
439 440 441 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 439 def voice_method @properties['voice_method'] end |
#voice_url ⇒ String
445 446 447 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 445 def voice_url @properties['voice_url'] end |