Class: Twilio::REST::Voice::V1::DialingPermissionsList::CountryList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CountryList

Initialize the CountryList

Parameters:

  • version (Version) —

    Version that contains the resource



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 27

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/DialingPermissions/Countries"
    
end

Instance Method Details

#each ⇒ Object

When passed a block, yields CountryInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 101

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of CountryInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CountryInstance



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 147

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
CountryPage.new(@version, response, @solution)
end

#list(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil) ⇒ Array

Lists CountryInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • iso_code (String) (defaults to: :unset) —

    Filter to retrieve the country permissions by specifying the [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

  • continent (String) (defaults to: :unset) —

    Filter to retrieve the country permissions by specifying the continent

  • country_code (String) (defaults to: :unset) —

    Filter the results by specified [country codes](www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)

  • low_risk_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with dialing to low-risk numbers enabled. Can be: ‘true` or `false`.

  • high_risk_special_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with dialing to high-risk special service numbers enabled. Can be: ‘true` or `false`

  • high_risk_tollfraud_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with 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 enabled. Can be: ‘true` or `false`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 52

def list(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil)
    self.stream(
        iso_code: iso_code,
        continent: continent,
        country_code: country_code,
        low_risk_numbers_enabled: low_risk_numbers_enabled,
        high_risk_special_numbers_enabled: high_risk_special_numbers_enabled,
        high_risk_tollfraud_numbers_enabled: high_risk_tollfraud_numbers_enabled,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of CountryInstance records from the API. Request is executed immediately.

Parameters:

  • iso_code (String) (defaults to: :unset) —

    Filter to retrieve the country permissions by specifying the [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

  • continent (String) (defaults to: :unset) —

    Filter to retrieve the country permissions by specifying the continent

  • country_code (String) (defaults to: :unset) —

    Filter the results by specified [country codes](www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)

  • low_risk_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with dialing to low-risk numbers enabled. Can be: ‘true` or `false`.

  • high_risk_special_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with dialing to high-risk special service numbers enabled. Can be: ‘true` or `false`

  • high_risk_tollfraud_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with 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 enabled. Can be: ‘true` or `false`.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of CountryInstance



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 124

def page(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'IsoCode' => iso_code,
        'Continent' => continent,
        'CountryCode' => country_code,
        'LowRiskNumbersEnabled' => low_risk_numbers_enabled,
        'HighRiskSpecialNumbersEnabled' => high_risk_special_numbers_enabled,
        'HighRiskTollfraudNumbersEnabled' => high_risk_tollfraud_numbers_enabled,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

    CountryPage.new(@version, response, @solution)
end

#stream(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • iso_code (String) (defaults to: :unset) —

    Filter to retrieve the country permissions by specifying the [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

  • continent (String) (defaults to: :unset) —

    Filter to retrieve the country permissions by specifying the continent

  • country_code (String) (defaults to: :unset) —

    Filter the results by specified [country codes](www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)

  • low_risk_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with dialing to low-risk numbers enabled. Can be: ‘true` or `false`.

  • high_risk_special_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with dialing to high-risk special service numbers enabled. Can be: ‘true` or `false`

  • high_risk_tollfraud_numbers_enabled (Boolean) (defaults to: :unset) —

    Filter to retrieve the country permissions with 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 enabled. Can be: ‘true` or `false`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 82

def stream(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        iso_code: iso_code,
        continent: continent,
        country_code: country_code,
        low_risk_numbers_enabled: low_risk_numbers_enabled,
        high_risk_special_numbers_enabled: high_risk_special_numbers_enabled,
        high_risk_tollfraud_numbers_enabled: high_risk_tollfraud_numbers_enabled,
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



158
159
160
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 158

def to_s
    '#<Twilio.Voice.V1.CountryList>'
end