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

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

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

  • account_sid (String) —

    The SID of the Account that created this Country resource.

  • sid (String) —

    The SID of the Call resource to fetch.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 268

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

#context ⇒ CountryContext

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

Returns:



293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 293

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

#continent ⇒ String

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.



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

def continent
    @properties['continent']
end

#country_codes ⇒ Array<String>

Returns The E.164 assigned [country codes(s)](www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html).

Returns:



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

def country_codes
    @properties['country_codes']
end

#fetch ⇒ CountryInstance

Fetch the CountryInstance

Returns:



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

def fetch

    context.fetch
end

#high_risk_special_numbers_enabled ⇒ Boolean

Returns Whether dialing to high-risk special services numbers is enabled. These prefixes include number ranges allocated by the country and include premium numbers, special services, shared cost, and others.

Returns:

  • (Boolean) —

    Whether dialing to high-risk special services numbers is enabled. These prefixes include number ranges allocated by the country and include premium numbers, special services, shared cost, and others



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

def high_risk_special_numbers_enabled
    @properties['high_risk_special_numbers_enabled']
end

#high_risk_tollfraud_numbers_enabled ⇒ Boolean

Returns Whether dialing to high-risk [toll fraud](www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html) numbers is enabled. These prefixes include narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks, also known as [toll fraud](www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html). These prefixes are collected from anti-fraud databases and verified by analyzing calls on our network. These prefixes are not available for download and are updated frequently.

Returns:



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

def high_risk_tollfraud_numbers_enabled
    @properties['high_risk_tollfraud_numbers_enabled']
end

#highrisk_special_prefixes ⇒ highrisk_special_prefixes

Access the highrisk_special_prefixes

Returns:



365
366
367
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 365

def highrisk_special_prefixes
    context.highrisk_special_prefixes
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 378

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

#iso_code ⇒ String

Returns The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

Returns:



302
303
304
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 302

def iso_code
    @properties['iso_code']
end

#links ⇒ Hash

Returns A list of URLs related to this resource.

Returns:

  • (Hash) —

    A list of URLs related to this resource.



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

def links
    @properties['links']
end

#low_risk_numbers_enabled ⇒ Boolean

Returns Whether dialing to low-risk numbers is enabled.

Returns:

  • (Boolean) —

    Whether dialing to low-risk numbers is enabled.



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

def low_risk_numbers_enabled
    @properties['low_risk_numbers_enabled']
end

#name ⇒ String

Returns The name of the country.

Returns:

  • (String) —

    The name of the country.



308
309
310
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 308

def name
    @properties['name']
end

#to_s ⇒ Object

Provide a user friendly representation



371
372
373
374
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 371

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

#url ⇒ String

Returns The absolute URL of this resource.

Returns:

  • (String) —

    The absolute URL of this resource.



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

def url
    @properties['url']
end