Class: Twilio::REST::Api::V2010::AccountContext::UsageList::RecordList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::UsageList::RecordList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/usage/record.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb
Defined Under Namespace
Classes: AllTimeInstance, AllTimeList, AllTimePage, DailyInstance, DailyList, DailyPage, LastMonthInstance, LastMonthList, LastMonthPage, MonthlyInstance, MonthlyList, MonthlyPage, ThisMonthInstance, ThisMonthList, ThisMonthPage, TodayInstance, TodayList, TodayPage, YearlyInstance, YearlyList, YearlyPage, YesterdayInstance, YesterdayList, YesterdayPage
Instance Method Summary collapse
-
#all_time ⇒ AllTimeList, AllTimeContext
Access the all_time.
-
#daily ⇒ DailyList, DailyContext
Access the daily.
-
#each ⇒ Object
When passed a block, yields RecordInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of RecordInstance records from the API.
-
#initialize(version, account_sid: nil) ⇒ RecordList
constructor
Initialize the RecordList.
-
#last_month ⇒ LastMonthList, LastMonthContext
Access the last_month.
-
#list(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil) ⇒ Array
Lists RecordInstance records from the API as a list.
-
#monthly ⇒ MonthlyList, MonthlyContext
Access the monthly.
-
#page(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of RecordInstance records from the API.
-
#stream(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#this_month ⇒ ThisMonthList, ThisMonthContext
Access the this_month.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#today ⇒ TodayList, TodayContext
Access the today.
-
#yearly ⇒ YearlyList, YearlyContext
Access the yearly.
-
#yesterday ⇒ YesterdayList, YesterdayContext
Access the yesterday.
Constructor Details
#initialize(version, account_sid: nil) ⇒ RecordList
Initialize the RecordList
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 28 def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Records.json" # Components @last_month = nil @today = nil @yearly = nil @this_month = nil @daily = nil @all_time = nil @yesterday = nil @monthly = nil end |
Instance Method Details
#all_time ⇒ AllTimeList, AllTimeContext
Access the all_time
192 193 194 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 192 def all_time @all_time ||= AllTimeList.new(@version, account_sid: @solution[:account_sid] ) end |
#daily ⇒ DailyList, DailyContext
Access the daily
185 186 187 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 185 def daily @daily ||= DailyList.new(@version, account_sid: @solution[:account_sid] ) end |
#each ⇒ Object
When passed a block, yields RecordInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
102 103 104 105 106 107 108 109 110 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 102 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 RecordInstance records from the API. Request is executed immediately.
144 145 146 147 148 149 150 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 144 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) RecordPage.new(@version, response, @solution) end |
#last_month ⇒ LastMonthList, LastMonthContext
Access the last_month
157 158 159 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 157 def last_month @last_month ||= LastMonthList.new(@version, account_sid: @solution[:account_sid] ) end |
#list(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil) ⇒ Array
Lists RecordInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
59 60 61 62 63 64 65 66 67 68 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 59 def list(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil) self.stream( category: category, start_date: start_date, end_date: end_date, include_subaccounts: include_subaccounts, limit: limit, page_size: page_size ).entries end |
#monthly ⇒ MonthlyList, MonthlyContext
Access the monthly
206 207 208 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 206 def monthly @monthly ||= MonthlyList.new(@version, account_sid: @solution[:account_sid] ) end |
#page(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of RecordInstance records from the API. Request is executed immediately.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 123 def page(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Category' => category, 'StartDate' => Twilio.serialize_iso8601_date(start_date), 'EndDate' => Twilio.serialize_iso8601_date(end_date), 'IncludeSubaccounts' => include_subaccounts, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) RecordPage.new(@version, response, @solution) end |
#stream(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :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.
85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 85 def stream(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( category: category, start_date: start_date, end_date: end_date, include_subaccounts: include_subaccounts, page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#this_month ⇒ ThisMonthList, ThisMonthContext
Access the this_month
178 179 180 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 178 def this_month @this_month ||= ThisMonthList.new(@version, account_sid: @solution[:account_sid] ) end |
#to_s ⇒ Object
Provide a user friendly representation
211 212 213 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 211 def to_s '#<Twilio.Api.V2010.RecordList>' end |
#today ⇒ TodayList, TodayContext
Access the today
164 165 166 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 164 def today @today ||= TodayList.new(@version, account_sid: @solution[:account_sid] ) end |
#yearly ⇒ YearlyList, YearlyContext
Access the yearly
171 172 173 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 171 def yearly @yearly ||= YearlyList.new(@version, account_sid: @solution[:account_sid] ) end |
#yesterday ⇒ YesterdayList, YesterdayContext
Access the yesterday
199 200 201 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 199 def yesterday @yesterday ||= YesterdayList.new(@version, account_sid: @solution[:account_sid] ) end |