Class: Twilio::REST::Api::V2010::AccountContext::AddressInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/address.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the AddressInstance



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 374

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' =>   ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



415
416
417
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 415

def 
    @properties['account_sid']
end

#city ⇒ String 



421
422
423
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 421

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



406
407
408
409
410
411
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 406

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

#customer_name ⇒ String 



427
428
429
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 427

def customer_name
    @properties['customer_name']
end

#date_created ⇒ Time 



433
434
435
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 433

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



439
440
441
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 439

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AddressInstance



512
513
514
515
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 512

def delete

    context.delete
end

#dependent_phone_numbers ⇒ dependent_phone_numbers

Access the dependent_phone_numbers



565
566
567
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 565

def dependent_phone_numbers
    context.dependent_phone_numbers
end

#emergency_enabled ⇒ Boolean 



487
488
489
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 487

def emergency_enabled
    @properties['emergency_enabled']
end

#fetch ⇒ AddressInstance

Fetch the AddressInstance



520
521
522
523
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 520

def fetch

    context.fetch
end

#friendly_name ⇒ String 



445
446
447
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 445

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



578
579
580
581
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 578

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

#iso_country ⇒ String 



451
452
453
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 451

def iso_country
    @properties['iso_country']
end

#postal_code ⇒ String 



457
458
459
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 457

def postal_code
    @properties['postal_code']
end

#region ⇒ String 



463
464
465
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 463

def region
    @properties['region']
end

#sid ⇒ String 



469
470
471
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 469

def sid
    @properties['sid']
end

#street ⇒ String 



475
476
477
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 475

def street
    @properties['street']
end

#street_secondary ⇒ String 



505
506
507
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 505

def street_secondary
    @properties['street_secondary']
end

#to_s ⇒ Object

Provide a user friendly representation



571
572
573
574
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 571

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



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 537

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 



481
482
483
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 481

def uri
    @properties['uri']
end

#validated ⇒ Boolean 



493
494
495
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 493

def validated
    @properties['validated']
end

#verified ⇒ Boolean 



499
500
501
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 499

def verified
    @properties['verified']
end