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

• #account_sid ⇒ String

  The unique id of the Account responsible for this address.

• #city ⇒ String

  The city in which you or your customer is located.

• #context ⇒ AddressContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #customer_name ⇒ String

  Your name or business name, or that of your customer.

• #date_created ⇒ Time

  The date_created.

• #date_updated ⇒ Time

  The date_updated.

• #delete ⇒ Boolean

  Deletes the AddressInstance.

• #dependent_phone_numbers ⇒ dependent_phone_numbers

  Access the dependent_phone_numbers.

• #emergency_enabled ⇒ Boolean

  This is a value that indicates if emergency calling has been enabled on this number.

• #fetch ⇒ AddressInstance

  Fetch a AddressInstance.

• #friendly_name ⇒ String

  A human-readable description of the address.

• #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 your or your customer’s address.

• #postal_code ⇒ String

  The postal code in which you or your customer is located.

• #region ⇒ String

  The state or region in which you or your customer is located.

• #sid ⇒ String

  A 34 character string that uniquely identifies this address.

• #street ⇒ String

  The number and street address where you or your customer is located.

• #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) ⇒ AddressInstance

  Update the AddressInstance.

• #uri ⇒ String

  The URI for this resource, relative to api.

• #validated ⇒ Boolean

  In some countries, addresses are validated to comply with local regulation.

Constructor Details

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

Initialize the AddressInstance

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

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'],
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#city ⇒ String

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

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

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

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

#customer_name ⇒ String

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

def customer_name
  @properties['customer_name']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AddressInstance

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

def delete
  context.delete
end

#dependent_phone_numbers ⇒ dependent_phone_numbers

Access the dependent_phone_numbers

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

def dependent_phone_numbers
  context.dependent_phone_numbers
end

#emergency_enabled ⇒ Boolean

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

def emergency_enabled
  @properties['emergency_enabled']
end

#fetch ⇒ AddressInstance

Fetch a AddressInstance

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

def fetch
  context.fetch
end

#friendly_name ⇒ String

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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#iso_country ⇒ String

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

def iso_country
  @properties['iso_country']
end

#postal_code ⇒ String

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

def postal_code
  @properties['postal_code']
end

#region ⇒ String

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

def region
  @properties['region']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#street ⇒ String

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

def street
  @properties['street']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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) ⇒ AddressInstance

Update the AddressInstance

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

def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :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,
  )
end

#uri ⇒ String

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

def uri
  @properties['uri']
end

#validated ⇒ Boolean

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

def validated
  @properties['validated']
end