Class: Twilio::REST::Voice::V1::DialingPermissionsList::CountryInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, iso_code: nil) ⇒ CountryInstance

Initialize the CountryInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • iso_code (String) (defaults to: nil)

    The ISO country code of the DialingPermissions Country resource to fetch


286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 286

def initialize(version, payload, iso_code: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'iso_code' => payload['iso_code'],
      'name' => payload['name'],
      'continent' => payload['continent'],
      'country_codes' => payload['country_codes'],
      'low_risk_numbers_enabled' => payload['low_risk_numbers_enabled'],
      'high_risk_special_numbers_enabled' => payload['high_risk_special_numbers_enabled'],
      'high_risk_tollfraud_numbers_enabled' => payload['high_risk_tollfraud_numbers_enabled'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#contextCountryContext

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

Returns:


311
312
313
314
315
316
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 311

def context
  unless @instance_context
    @instance_context = CountryContext.new(@version, @params['iso_code'], )
  end
  @instance_context
end

#continentString

Returns The name of the continent in which the country is located.

Returns:

  • (String)

    The name of the continent in which the country is located


332
333
334
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 332

def continent
  @properties['continent']
end

#country_codesArray[String]

Returns The E.164 assigned country codes(s).

Returns:

  • (Array[String])

    The E.164 assigned country codes(s)


338
339
340
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 338

def country_codes
  @properties['country_codes']
end

#fetchCountryInstance

Fetch the CountryInstance

Returns:


375
376
377
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 375

def fetch
  context.fetch
end

#high_risk_special_numbers_enabledBoolean

Returns Whether dialing to high-risk special services numbers is enabled.

Returns:

  • (Boolean)

    Whether dialing to high-risk special services numbers is enabled


350
351
352
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 350

def high_risk_special_numbers_enabled
  @properties['high_risk_special_numbers_enabled']
end

#high_risk_tollfraud_numbers_enabledBoolean

Returns Whether dialing to high-risk toll fraud numbers is enabled, else `false`.

Returns:

  • (Boolean)

    Whether dialing to high-risk toll fraud numbers is enabled, else `false`


356
357
358
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 356

def high_risk_tollfraud_numbers_enabled
  @properties['high_risk_tollfraud_numbers_enabled']
end

#highrisk_special_prefixeshighrisk_special_prefixes

Access the highrisk_special_prefixes

Returns:


382
383
384
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 382

def highrisk_special_prefixes
  context.highrisk_special_prefixes
end

#inspectObject

Provide a detailed, user friendly representation


395
396
397
398
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 395

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

#iso_codeString

Returns The ISO country code.

Returns:

  • (String)

    The ISO country code


320
321
322
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 320

def iso_code
  @properties['iso_code']
end

Returns A list of URLs related to this resource.

Returns:

  • (String)

    A list of URLs related to this resource


368
369
370
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 368

def links
  @properties['links']
end

#low_risk_numbers_enabledBoolean

Returns Whether dialing to low-risk numbers is enabled.

Returns:

  • (Boolean)

    Whether dialing to low-risk numbers is enabled


344
345
346
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 344

def low_risk_numbers_enabled
  @properties['low_risk_numbers_enabled']
end

#nameString

Returns The name of the country.

Returns:

  • (String)

    The name of the country


326
327
328
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 326

def name
  @properties['name']
end

#to_sObject

Provide a user friendly representation


388
389
390
391
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 388

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

#urlString

Returns The absolute URL of this resource.

Returns:

  • (String)

    The absolute URL of this resource


362
363
364
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 362

def url
  @properties['url']
end