Class: Twilio::REST::Pricing::V1::MessagingList::CountryList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/pricing/v1/messaging/country.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CountryList

Initialize the CountryList



17
18
19
20
21
22
23
 
# File 'lib/twilio-ruby/rest/pricing/v1/messaging/country.rb', line 17

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Messaging/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.



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/pricing/v1/messaging/country.rb', line 68

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.



106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/pricing/v1/messaging/country.rb', line 106

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

#list(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.



36
37
38
39
40
41
 
# File 'lib/twilio-ruby/rest/pricing/v1/messaging/country.rb', line 36

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



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/pricing/v1/messaging/country.rb', line 87

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
  )
  CountryPage.new(@version, response, @solution)
end

#stream(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.



54
55
56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/pricing/v1/messaging/country.rb', line 54

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



116
117
118
 
# File 'lib/twilio-ruby/rest/pricing/v1/messaging/country.rb', line 116

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