Class: Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ AvailablePhoneNumberCountryList

Initialize the AvailablePhoneNumberCountryList



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 21

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

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

Instance Method Details

#each ⇒ Object

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



67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 67

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



103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 103

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

#list(limit: nil, page_size: nil) ⇒ Array

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



40
41
42
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 40

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 84

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  AvailablePhoneNumberCountryPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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



55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 55

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(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



113
114
115
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 113

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