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 that created the resource.
-
#address_requirements ⇒ phone_number.AddressRequirement
Whether the phone number requires an Address registered with Twilio.
-
#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
Indicate if a phone 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 RFC 2822 date and time in GMT when the resource was created.
-
#date_updated ⇒ Time
The RFC 2822 date and time in GMT when the resource was last updated.
-
#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 ⇒ String
The URLs of related resources.
-
#phone_number ⇒ String
The phone number in E.164 format.
-
#sid ⇒ String
The unique string that identifies the 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 used with sms_fallback_url.
-
#sms_fallback_url ⇒ String
The URL that we call when an error occurs while retrieving or executing the TwiML.
-
#sms_method ⇒ String
The HTTP method to use with sms_url.
-
#sms_url ⇒ String
The URL we call when the phone number receives an incoming SMS message.
-
#status_callback ⇒ String
The URL 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 to lookup the caller's name.
-
#voice_fallback_method ⇒ String
The HTTP method that we use to call voice_fallback_url.
-
#voice_fallback_url ⇒ String
The URL we call when an error occurs in TwiML.
-
#voice_method ⇒ String
The HTTP method used with the voice_url.
-
#voice_url ⇒ String
The URL we call when the phone number receives a call.
Constructor Details
#initialize(version, payload, trunk_sid: nil, sid: nil) ⇒ PhoneNumberInstance
Initialize the PhoneNumberInstance
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 221 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, 'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the Account that created the resource.
272 273 274 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 272 def account_sid @properties['account_sid'] end |
#address_requirements ⇒ phone_number.AddressRequirement
Returns Whether the phone number requires an Address registered with Twilio.
278 279 280 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 278 def address_requirements @properties['address_requirements'] end |
#api_version ⇒ String
Returns The API version used to start a new TwiML session.
284 285 286 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 284 def api_version @properties['api_version'] end |
#beta ⇒ Boolean
Returns Whether the phone number is new to the Twilio platform.
290 291 292 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 290 def beta @properties['beta'] end |
#capabilities ⇒ Hash
Returns Indicate if a phone can receive calls or messages.
296 297 298 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 296 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
263 264 265 266 267 268 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 263 def context unless @instance_context @instance_context = PhoneNumberContext.new(@version, @params['trunk_sid'], @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The RFC 2822 date and time in GMT when the resource was created.
302 303 304 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 302 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The RFC 2822 date and time in GMT when the resource was last updated.
308 309 310 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 308 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the PhoneNumberInstance
436 437 438 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 436 def delete context.delete end |
#fetch ⇒ PhoneNumberInstance
Fetch the PhoneNumberInstance
429 430 431 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 429 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
314 315 316 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 314 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
449 450 451 452 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 449 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Trunking.V1.PhoneNumberInstance #{values}>" end |
#links ⇒ String
Returns The URLs of related resources.
320 321 322 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 320 def links @properties['links'] end |
#phone_number ⇒ String
Returns The phone number in E.164 format.
326 327 328 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 326 def phone_number @properties['phone_number'] end |
#sid ⇒ String
Returns The unique string that identifies the resource.
332 333 334 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 332 def sid @properties['sid'] end |
#sms_application_sid ⇒ String
Returns The SID of the application that handles SMS messages sent to the phone number.
338 339 340 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 338 def sms_application_sid @properties['sms_application_sid'] end |
#sms_fallback_method ⇒ String
Returns The HTTP method used with sms_fallback_url.
344 345 346 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 344 def sms_fallback_method @properties['sms_fallback_method'] end |
#sms_fallback_url ⇒ String
Returns The URL that we call when an error occurs while retrieving or executing the TwiML.
350 351 352 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 350 def sms_fallback_url @properties['sms_fallback_url'] end |
#sms_method ⇒ String
Returns The HTTP method to use with sms_url.
356 357 358 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 356 def sms_method @properties['sms_method'] end |
#sms_url ⇒ String
Returns The URL we call when the phone number receives an incoming SMS message.
362 363 364 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 362 def sms_url @properties['sms_url'] end |
#status_callback ⇒ String
Returns The URL to send status information to your application.
368 369 370 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 368 def status_callback @properties['status_callback'] end |
#status_callback_method ⇒ String
Returns The HTTP method we use to call status_callback.
374 375 376 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 374 def status_callback_method @properties['status_callback_method'] end |
#to_s ⇒ Object
Provide a user friendly representation
442 443 444 445 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 442 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.
380 381 382 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 380 def trunk_sid @properties['trunk_sid'] end |
#url ⇒ String
Returns The absolute URL of the resource.
386 387 388 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 386 def url @properties['url'] end |
#voice_application_sid ⇒ String
Returns The SID of the application that handles calls to the phone number.
392 393 394 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 392 def voice_application_sid @properties['voice_application_sid'] end |
#voice_caller_id_lookup ⇒ Boolean
Returns Whether to lookup the caller's name.
398 399 400 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 398 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.
404 405 406 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 404 def voice_fallback_method @properties['voice_fallback_method'] end |
#voice_fallback_url ⇒ String
Returns The URL we call when an error occurs in TwiML.
410 411 412 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 410 def voice_fallback_url @properties['voice_fallback_url'] end |
#voice_method ⇒ String
Returns The HTTP method used with the voice_url.
416 417 418 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 416 def voice_method @properties['voice_method'] end |
#voice_url ⇒ String
Returns The URL we call when the phone number receives a call.
422 423 424 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 422 def voice_url @properties['voice_url'] end |