Class: Twilio::REST::Wireless::V1::SimContext::UsageRecordList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sim_sid: nil) ⇒ UsageRecordList

Initialize the UsageRecordList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 22

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

  # Path Solution
  @solution = {sim_sid: sim_sid}
  @uri = "/Sims/#{@solution[:sim_sid]}/UsageRecords"
end

Instance Method Details

#each ⇒ Object

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



92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 92

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



138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 138

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

#list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil) ⇒ Array

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



50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 50

def list(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
  self.stream(
      end_: end_,
      start: start,
      granularity: granularity,
      limit: limit,
      page_size: page_size
  ).entries
end

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

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 118

def page(end_: :unset, start: :unset, granularity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'End' => Twilio.serialize_iso8601_datetime(end_),
      'Start' => Twilio.serialize_iso8601_datetime(start),
      'Granularity' => granularity,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  UsageRecordPage.new(@version, response, @solution)
end

#stream(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



80
81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 80

def stream(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(end_: end_, start: start, granularity: granularity, 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



148
149
150
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb', line 148

def to_s
  '#<Twilio.Wireless.V1.UsageRecordList>'
end