Class: Twilio::REST::Api::V2010::AccountContext::AddressInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::AddressInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/address.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that is responsible for the Address resource.
-
#city ⇒ String
The city in which the address is located.
-
#context ⇒ AddressContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#customer_name ⇒ String
The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.
-
#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 AddressInstance.
-
#dependent_phone_numbers ⇒ dependent_phone_numbers
Access the dependent_phone_numbers.
-
#emergency_enabled ⇒ Boolean
Whether emergency calling has been enabled on this number.
-
#fetch ⇒ AddressInstance
Fetch the AddressInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ AddressInstance
constructor
Initialize the AddressInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#iso_country ⇒ String
The ISO country code of the address.
-
#postal_code ⇒ String
The postal code of the address.
-
#region ⇒ String
The state or region of the address.
-
#sid ⇒ String
The unique string that that we created to identify the Address resource.
-
#street ⇒ String
The number and street address of the address.
-
#street_secondary ⇒ String
The additional number and street address of the address.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset, street_secondary: :unset) ⇒ AddressInstance
Update the AddressInstance.
-
#uri ⇒ String
The URI of the resource, relative to ‘api.twilio.com`.
-
#validated ⇒ Boolean
Whether the address has been validated to comply with local regulation.
-
#verified ⇒ Boolean
Whether the address has been verified to comply with regulation.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ AddressInstance
Initialize the AddressInstance
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 342 def initialize(version, payload , account_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'city' => payload['city'], 'customer_name' => payload['customer_name'], 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 'friendly_name' => payload['friendly_name'], 'iso_country' => payload['iso_country'], 'postal_code' => payload['postal_code'], 'region' => payload['region'], 'sid' => payload['sid'], 'street' => payload['street'], 'uri' => payload['uri'], 'emergency_enabled' => payload['emergency_enabled'], 'validated' => payload['validated'], 'verified' => payload['verified'], 'street_secondary' => payload['street_secondary'], } # Context @instance_context = nil @params = { 'account_sid' => account_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 is responsible for the Address resource.
383 384 385 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 383 def account_sid @properties['account_sid'] end |
#city ⇒ String
Returns The city in which the address is located.
389 390 391 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 389 def city @properties['city'] end |
#context ⇒ AddressContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
374 375 376 377 378 379 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 374 def context unless @instance_context @instance_context = AddressContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end |
#customer_name ⇒ String
Returns The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.
395 396 397 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 395 def customer_name @properties['customer_name'] end |
#date_created ⇒ Time
Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
401 402 403 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 401 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](www.ietf.org/rfc/rfc2822.txt) format.
407 408 409 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 407 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the AddressInstance
480 481 482 483 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 480 def delete context.delete end |
#dependent_phone_numbers ⇒ dependent_phone_numbers
Access the dependent_phone_numbers
533 534 535 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 533 def dependent_phone_numbers context.dependent_phone_numbers end |
#emergency_enabled ⇒ Boolean
Returns Whether emergency calling has been enabled on this number.
455 456 457 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 455 def emergency_enabled @properties['emergency_enabled'] end |
#fetch ⇒ AddressInstance
Fetch the AddressInstance
488 489 490 491 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 488 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
413 414 415 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 413 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
546 547 548 549 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 546 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.AddressInstance #{values}>" end |
#iso_country ⇒ String
Returns The ISO country code of the address.
419 420 421 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 419 def iso_country @properties['iso_country'] end |
#postal_code ⇒ String
Returns The postal code of the address.
425 426 427 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 425 def postal_code @properties['postal_code'] end |
#region ⇒ String
Returns The state or region of the address.
431 432 433 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 431 def region @properties['region'] end |
#sid ⇒ String
Returns The unique string that that we created to identify the Address resource.
437 438 439 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 437 def sid @properties['sid'] end |
#street ⇒ String
Returns The number and street address of the address.
443 444 445 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 443 def street @properties['street'] end |
#street_secondary ⇒ String
Returns The additional number and street address of the address.
473 474 475 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 473 def street_secondary @properties['street_secondary'] end |
#to_s ⇒ Object
Provide a user friendly representation
539 540 541 542 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 539 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.AddressInstance #{values}>" end |
#update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset, street_secondary: :unset) ⇒ AddressInstance
Update the AddressInstance
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 505 def update( friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset, street_secondary: :unset ) context.update( friendly_name: friendly_name, customer_name: customer_name, street: street, city: city, region: region, postal_code: postal_code, emergency_enabled: emergency_enabled, auto_correct_address: auto_correct_address, street_secondary: street_secondary, ) end |
#uri ⇒ String
Returns The URI of the resource, relative to ‘api.twilio.com`.
449 450 451 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 449 def uri @properties['uri'] end |
#validated ⇒ Boolean
Returns Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. ‘true` indicates the Address has been validated. `false` indicate the country doesn’t require validation or the Address is not valid.
461 462 463 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 461 def validated @properties['validated'] end |
#verified ⇒ Boolean
Returns Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. ‘true` indicates the Address has been verified. `false` indicate the country doesn’t require verified or the Address is not valid.
467 468 469 |
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 467 def verified @properties['verified'] end |