Class: Twilio::REST::Api::V2010::AccountContext::UsageList::RecordList

Inherits:
ListResource
  • Object
show all
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

Constructor Details

#initialize(version, account_sid: nil) ⇒ RecordList

Initialize the RecordList

Parameters:

  • version (Version)

    Version that contains the resource

  • account_sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this resource.


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 22

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

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Records.json"

  # Components
  @all_time = nil
  @daily = nil
  @last_month = nil
  @monthly = nil
  @this_month = nil
  @today = nil
  @yearly = nil
  @yesterday = nil
end

Instance Method Details

#all_timeAllTimeList, AllTimeContext

Access the all_time

Returns:


189
190
191
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 189

def all_time
  @all_time ||= AllTimeList.new(@version, account_sid: @solution[:account_sid], )
end

#dailyDailyList, DailyContext

Access the daily

Returns:


197
198
199
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 197

def daily
  @daily ||= DailyList.new(@version, account_sid: @solution[:account_sid], )
end

#eachObject

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


123
124
125
126
127
128
129
130
131
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 123

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.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of RecordInstance


177
178
179
180
181
182
183
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 177

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

#last_monthLastMonthList, LastMonthContext

Access the last_month

Returns:


205
206
207
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 205

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.

Parameters:

  • category (record.Category) (defaults to: :unset)

    The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.

  • start_date (Date) (defaults to: :unset)

    Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.

  • end_date (Date) (defaults to: :unset)

    Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.

  • include_subaccounts (Boolean) (defaults to: :unset)

    Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    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)

Returns:

  • (Array)

    Array of up to limit results


67
68
69
70
71
72
73
74
75
76
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 67

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

#monthlyMonthlyList, MonthlyContext

Access the monthly

Returns:


213
214
215
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 213

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.

Parameters:

  • category (record.Category) (defaults to: :unset)

    The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.

  • start_date (Date) (defaults to: :unset)

    Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.

  • end_date (Date) (defaults to: :unset)

    Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.

  • include_subaccounts (Boolean) (defaults to: :unset)

    Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of RecordInstance


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 156

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 RecordInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • category (record.Category) (defaults to: :unset)

    The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.

  • start_date (Date) (defaults to: :unset)

    Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.

  • end_date (Date) (defaults to: :unset)

    Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.

  • include_subaccounts (Boolean) (defaults to: :unset)

    Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    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)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 105

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_monthThisMonthList, ThisMonthContext

Access the this_month

Returns:


221
222
223
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 221

def this_month
  @this_month ||= ThisMonthList.new(@version, account_sid: @solution[:account_sid], )
end

#to_sObject

Provide a user friendly representation


251
252
253
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 251

def to_s
  '#<Twilio.Api.V2010.RecordList>'
end

#todayTodayList, TodayContext

Access the today

Returns:


229
230
231
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 229

def today
  @today ||= TodayList.new(@version, account_sid: @solution[:account_sid], )
end

#yearlyYearlyList, YearlyContext

Access the yearly

Returns:


237
238
239
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 237

def yearly
  @yearly ||= YearlyList.new(@version, account_sid: @solution[:account_sid], )
end

#yesterdayYesterdayList, YesterdayContext

Access the yesterday

Returns:


245
246
247
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 245

def yesterday
  @yesterday ||= YesterdayList.new(@version, account_sid: @solution[:account_sid], )
end