class Twilio::REST::Pricing::V2::CountryList

Public Class Methods

new(version) click to toggle source

Initialize the CountryList @param [Version] version Version that contains the resource @return [CountryList] CountryList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/pricing/v2/country.rb
18 def initialize(version)
19   super(version)
20 
21   # Path Solution
22   @solution = {}
23   @uri = "/Trunking/Countries"
24 end

Public Instance Methods

each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/pricing/v2/country.rb
64 def each
65   limits = @version.read_limits
66 
67   page = self.page(page_size: limits[:page_size], )
68 
69   @version.stream(page,
70                   limit: limits[:limit],
71                   page_limit: limits[:page_limit]).each {|x| yield x}
72 end
get_page(target_url) click to toggle source

Retrieve a single page of CountryInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of CountryInstance

    # File lib/twilio-ruby/rest/pricing/v2/country.rb
 98 def get_page(target_url)
 99   response = @version.domain.request(
100       'GET',
101       target_url
102   )
103   CountryPage.new(@version, response, @solution)
104 end
list(limit: nil, page_size: nil) click to toggle source

Lists CountryInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records.  If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/pricing/v2/country.rb
37 def list(limit: nil, page_size: nil)
38   self.stream(limit: limit, page_size: page_size).entries
39 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of CountryInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of CountryInstance

   # File lib/twilio-ruby/rest/pricing/v2/country.rb
81 def page(page_token: :unset, page_number: :unset, page_size: :unset)
82   params = Twilio::Values.of({
83       'PageToken' => page_token,
84       'Page' => page_number,
85       'PageSize' => page_size,
86   })
87 
88   response = @version.page('GET', @uri, params: params)
89 
90   CountryPage.new(@version, response, @solution)
91 end
stream(limit: nil, page_size: nil) click to toggle source

Streams CountryInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/pricing/v2/country.rb
52 def stream(limit: nil, page_size: nil)
53   limits = @version.read_limits(limit, page_size)
54 
55   page = self.page(page_size: limits[:page_size], )
56 
57   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
58 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/pricing/v2/country.rb
108 def to_s
109   '#<Twilio.Pricing.V2.CountryList>'
110 end