Class: Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, country_code: nil) ⇒ AvailablePhoneNumberCountryInstance

Initialize the AvailablePhoneNumberCountryInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this resource.

  • country_code (String) (defaults to: nil)

    The ISO-3166-1 country code of the country to fetch available phone number information about.


325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 325

def initialize(version, payload, account_sid: nil, country_code: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'country_code' => payload['country_code'],
      'country' => payload['country'],
      'uri' => payload['uri'],
      'beta' => payload['beta'],
      'subresource_uris' => payload['subresource_uris'],
  }

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

Instance Method Details

#betaBoolean

Returns Whether all phone numbers available in the country are new to the Twilio platform.

Returns:

  • (Boolean)

    Whether all phone numbers available in the country are new to the Twilio platform.


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

def beta
  @properties['beta']
end

#contextAvailablePhoneNumberCountryContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


349
350
351
352
353
354
355
356
357
358
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 349

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

#countryString

Returns The name of the country.

Returns:

  • (String)

    The name of the country


368
369
370
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 368

def country
  @properties['country']
end

#country_codeString

Returns The ISO-3166-1 country code of the country.

Returns:

  • (String)

    The ISO-3166-1 country code of the country.


362
363
364
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 362

def country_code
  @properties['country_code']
end

#fetchAvailablePhoneNumberCountryInstance

Fetch the AvailablePhoneNumberCountryInstance

Returns:


393
394
395
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 393

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#locallocal

Access the local

Returns:


400
401
402
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 400

def local
  context.local
end

#machine_to_machinemachine_to_machine

Access the machine_to_machine

Returns:


442
443
444
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 442

def machine_to_machine
  context.machine_to_machine
end

#mobilemobile

Access the mobile

Returns:


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

def mobile
  context.mobile
end

#nationalnational

Access the national

Returns:


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

def national
  context.national
end

#shared_costshared_cost

Access the shared_cost

Returns:


435
436
437
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 435

def shared_cost
  context.shared_cost
end

#subresource_urisString

Returns A list of related resources identified by their relative URIs.

Returns:

  • (String)

    A list of related resources identified by their relative URIs


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

def subresource_uris
  @properties['subresource_uris']
end

#to_sObject

Provide a user friendly representation


448
449
450
451
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 448

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

#toll_freetoll_free

Access the toll_free

Returns:


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

def toll_free
  context.toll_free
end

#uriString

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

Returns:

  • (String)

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


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

def uri
  @properties['uri']
end

#voipvoip

Access the voip

Returns:


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

def voip
  context.voip
end