Class: Twilio::REST::Api::V2010::AccountContext::AddressContext

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

Defined Under Namespace

Classes: DependentPhoneNumberInstance, DependentPhoneNumberList, DependentPhoneNumberPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ AddressContext

Initialize the AddressContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The SID of the [Account](www.twilio.com/docs/api/rest/account) that is responsible for the Address resource to fetch.

  • sid (String) —

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



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 230

def initialize(version, , sid)
  super(version)

  # Path Solution
  @solution = {account_sid: , sid: sid, }
  @uri = "/Accounts/#{@solution[:account_sid]}/Addresses/#{@solution[:sid]}.json"

  # Dependents
  @dependent_phone_numbers = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the AddressInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  @version.delete('delete', @uri)
end

#dependent_phone_numbers ⇒ DependentPhoneNumberList, DependentPhoneNumberContext

Access the dependent_phone_numbers

Returns:



304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 304

def dependent_phone_numbers
  unless @dependent_phone_numbers
    @dependent_phone_numbers = DependentPhoneNumberList.new(
        @version,
        account_sid: @solution[:account_sid],
        address_sid: @solution[:sid],
    )
  end

  @dependent_phone_numbers
end

#fetch ⇒ AddressInstance

Fetch a AddressInstance

Returns:



251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 251

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



325
326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 325

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.AddressContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



318
319
320
321
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 318

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.AddressContext #{context}>"
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

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.

Returns:



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address.rb', line 279

def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'CustomerName' => customer_name,
      'Street' => street,
      'City' => city,
      'Region' => region,
      'PostalCode' => postal_code,
      'EmergencyEnabled' => emergency_enabled,
      'AutoCorrectAddress' => auto_correct_address,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end