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

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ YearlyList

Initialize the YearlyList

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies this resource.


23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb', line 23

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

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

Instance Method Details

#each ⇒ Object

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


114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb', line 114

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of YearlyInstance


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

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

#list(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • category (yearly.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


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

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

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

Parameters:

  • category (yearly.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 YearlyInstance


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb', line 147

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)

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

#stream(category: :unset, start_date: :unset, end_date: :unset, include_subaccounts: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • category (yearly.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


96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb', line 96

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

#to_s ⇒ Object

Provide a user friendly representation


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

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