Class: Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryContext::LocalList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, country_code: nil) ⇒ LocalList

Initialize the LocalList



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb', line 24

def initialize(version, account_sid: nil, country_code: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: , country_code: country_code}
  @uri = "/Accounts/#{@solution[:account_sid]}/AvailablePhoneNumbers/#{@solution[:country_code]}/Local.json"
end

Instance Method Details

#each ⇒ Object

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



213
214
215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb', line 213

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 LocalInstance records from the API. Request is executed immediately.



318
319
320
321
322
323
324
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb', line 318

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

#list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil) ⇒ Array

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb', line 94

def list(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil)
  self.stream(
      area_code: area_code,
      contains: contains,
      sms_enabled: sms_enabled,
      mms_enabled: mms_enabled,
      voice_enabled: voice_enabled,
      exclude_all_address_required: exclude_all_address_required,
      exclude_local_address_required: exclude_local_address_required,
      exclude_foreign_address_required: exclude_foreign_address_required,
      beta: beta,
      near_number: near_number,
      near_lat_long: near_lat_long,
      distance: distance,
      in_postal_code: in_postal_code,
      in_region: in_region,
      in_rate_center: in_rate_center,
      in_lata: in_lata,
      in_locality: in_locality,
      fax_enabled: fax_enabled,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb', line 281

def page(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'AreaCode' => area_code,
      'Contains' => contains,
      'SmsEnabled' => sms_enabled,
      'MmsEnabled' => mms_enabled,
      'VoiceEnabled' => voice_enabled,
      'ExcludeAllAddressRequired' => exclude_all_address_required,
      'ExcludeLocalAddressRequired' => exclude_local_address_required,
      'ExcludeForeignAddressRequired' => exclude_foreign_address_required,
      'Beta' => beta,
      'NearNumber' => near_number,
      'NearLatLong' => near_lat_long,
      'Distance' => distance,
      'InPostalCode' => in_postal_code,
      'InRegion' => in_region,
      'InRateCenter' => in_rate_center,
      'InLata' => in_lata,
      'InLocality' => in_locality,
      'FaxEnabled' => fax_enabled,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  LocalPage.new(@version, response, @solution)
end

#stream(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb', line 181

def stream(area_code: :unset, contains: :unset, sms_enabled: :unset, mms_enabled: :unset, voice_enabled: :unset, exclude_all_address_required: :unset, exclude_local_address_required: :unset, exclude_foreign_address_required: :unset, beta: :unset, near_number: :unset, near_lat_long: :unset, distance: :unset, in_postal_code: :unset, in_region: :unset, in_rate_center: :unset, in_lata: :unset, in_locality: :unset, fax_enabled: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      area_code: area_code,
      contains: contains,
      sms_enabled: sms_enabled,
      mms_enabled: mms_enabled,
      voice_enabled: voice_enabled,
      exclude_all_address_required: exclude_all_address_required,
      exclude_local_address_required: exclude_local_address_required,
      exclude_foreign_address_required: exclude_foreign_address_required,
      beta: beta,
      near_number: near_number,
      near_lat_long: near_lat_long,
      distance: distance,
      in_postal_code: in_postal_code,
      in_region: in_region,
      in_rate_center: in_rate_center,
      in_lata: in_lata,
      in_locality: in_locality,
      fax_enabled: fax_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



328
329
330
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb', line 328

def to_s
  '#<Twilio.Api.V2010.LocalList>'
end