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

Inherits:
ListResource
  • 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) ⇒ CountryList

Initialize the CountryList



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 21

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.



116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 116

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.



172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 172

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.



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

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.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 149

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 CountryInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



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

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



182
183
184
 
# File 'lib/twilio-ruby/rest/voice/v1/dialing_permissions/country.rb', line 182

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