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



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

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.



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

def each
    limits = @version.read_limits

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

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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



194
195
196
197
198
199
200
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 194

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.



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

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

#list_with_metadata(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 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 118

def list_with_metadata(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)
    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,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    CountryPageMetadata.new(@version, response, @solution, limits[:limit])
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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 168

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,
    })
    headers = Twilio::Values.of({})
    
    

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

    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.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 84

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], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



205
206
207
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 205

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