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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The SID of the Account that is responsible for the Address resource.

  • sid (String) (defaults to: nil) —

    The Twilio-provided string that uniquely identifies the Address resource to fetch.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 331

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

Returns The SID of the Account that is responsible for the resource.

Returns:

  • (String) —

    The SID of the Account that is responsible for the resource



372
373
374
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 372

def 
  @properties['account_sid']
end

#city ⇒ String

Returns The city in which the address is located.

Returns:

  • (String) —

    The city in which the address is located



378
379
380
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 378

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

Returns:



363
364
365
366
367
368
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 363

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.

Returns:

  • (String) —

    The name associated with the address



384
385
386
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 384

def customer_name
  @properties['customer_name']
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created



390
391
392
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 390

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated



396
397
398
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 396

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AddressInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#dependent_phone_numbers ⇒ dependent_phone_numbers

Access the dependent_phone_numbers

Returns:



515
516
517
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 515

def dependent_phone_numbers
  context.dependent_phone_numbers
end

#emergency_enabled ⇒ Boolean

Returns Whether emergency calling has been enabled on this number.

Returns:

  • (Boolean) —

    Whether emergency calling has been enabled on this number



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

def emergency_enabled
  @properties['emergency_enabled']
end

#fetch ⇒ AddressInstance

Fetch the AddressInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



402
403
404
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 402

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



528
529
530
531
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 528

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.

Returns:

  • (String) —

    The ISO country code of the address



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

def iso_country
  @properties['iso_country']
end

#postal_code ⇒ String

Returns The postal code of the address.

Returns:

  • (String) —

    The postal code of the address



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

def postal_code
  @properties['postal_code']
end

#region ⇒ String

Returns The state or region of the address.

Returns:

  • (String) —

    The state or region of the address



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

def region
  @properties['region']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#street ⇒ String

Returns The number and street address of the address.

Returns:

  • (String) —

    The number and street address of the address



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

def street
  @properties['street']
end

#street_secondary ⇒ String

Returns The additional number and street address of the address.

Returns:

  • (String) —

    The additional number and street address of the address



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

def street_secondary
  @properties['street_secondary']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the address. It can be up to 64 characters long.

  • customer_name (String) (defaults to: :unset) —

    The name to associate with the address.

  • street (String) (defaults to: :unset) —

    The number and street address of the address.

  • city (String) (defaults to: :unset) —

    The city of the address.

  • region (String) (defaults to: :unset) —

    The state or region of the address.

  • postal_code (String) (defaults to: :unset) —

    The postal code of the address.

  • emergency_enabled (Boolean) (defaults to: :unset) —

    Whether to enable emergency calling on the address. Can be: ‘true` or `false`.

  • auto_correct_address (Boolean) (defaults to: :unset) —

    Whether we should automatically correct the address. Can be: ‘true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won’t alter the address you provide.

  • street_secondary (String) (defaults to: :unset) —

    The additional number and street address of the address.

Returns:



498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 498

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`.

Returns:

  • (String) —

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



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

def uri
  @properties['uri']
end

#validated ⇒ Boolean

Returns Whether the address has been validated to comply with local regulation.

Returns:

  • (Boolean) —

    Whether the address has been validated to comply with local regulation



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

def validated
  @properties['validated']
end

#verified ⇒ Boolean

Returns Whether the address has been verified to comply with regulation.

Returns:

  • (Boolean) —

    Whether the address has been verified to comply with regulation



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

def verified
  @properties['verified']
end