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



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.



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

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.



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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# 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.



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



165
166
167
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 165

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