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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 29

def initialize(version, account_sid: nil)
    super(version)
    # Path Solution
    @solution = { 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

Returns:



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

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

#daily ⇒ DailyList, DailyContext

Access the daily

Returns:



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

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.



103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 103

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



148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 148

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

Returns:



161
162
163
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 161

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 (Category) (defaults to: :unset) —

    The [usage category](www.twilio.com/docs/usage/api/usage-record#usage-categories) 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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 60

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

Returns:



210
211
212
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 210

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 (Category) (defaults to: :unset) —

    The [usage category](www.twilio.com/docs/usage/api/usage-record#usage-categories) 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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 124

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,
    })
    headers = Twilio::Values.of({})
    
    

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

    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.

Parameters:

  • category (Category) (defaults to: :unset) —

    The [usage category](www.twilio.com/docs/usage/api/usage-record#usage-categories) 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



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 86

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

Returns:



182
183
184
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 182

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

#today ⇒ TodayList, TodayContext

Access the today

Returns:



168
169
170
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 168

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

#yearly ⇒ YearlyList, YearlyContext

Access the yearly

Returns:



175
176
177
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record.rb', line 175

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

#yesterday ⇒ YesterdayList, YesterdayContext

Access the yesterday

Returns:



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

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