Class: Twilio::REST::Supersim::V1::UsageRecordList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Supersim::V1::UsageRecordList
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/usage_record.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields UsageRecordInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of UsageRecordInstance records from the API.
-
#initialize(version) ⇒ UsageRecordList
constructor
Initialize the UsageRecordList.
-
#list(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil) ⇒ Array
Lists UsageRecordInstance records from the API as a list.
-
#page(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of UsageRecordInstance records from the API.
-
#stream(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ UsageRecordList
Initialize the UsageRecordList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/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.
107 108 109 110 111 112 113 114 115 |
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 107 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.
166 167 168 169 170 171 172 |
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 166 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) UsageRecordPage.new(@version, response, @solution) end |
#list(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :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.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 52 def list(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil) self.stream( sim: sim, fleet: fleet, network: network, iso_country: iso_country, group: group, granularity: granularity, start_time: start_time, end_time: end_time, limit: limit, page_size: page_size ).entries end |
#page(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :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.
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 132 def page(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Sim' => sim, 'Fleet' => fleet, 'Network' => network, 'IsoCountry' => iso_country, 'Group' => group, 'Granularity' => granularity, 'StartTime' => Twilio.serialize_iso8601_datetime(start_time), 'EndTime' => Twilio.serialize_iso8601_datetime(end_time), 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) UsageRecordPage.new(@version, response, @solution) end |
#stream(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 86 def stream(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( sim: sim, fleet: fleet, network: network, iso_country: iso_country, group: group, granularity: granularity, start_time: start_time, end_time: end_time, 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
177 178 179 |
# File 'lib/twilio-ruby/rest/supersim/v1/usage_record.rb', line 177 def to_s '#<Twilio.Supersim.V1.UsageRecordList>' end |