twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -30,9 +32,22 @@ module Twilio
                 # Lists TodayInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [today.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [today.Category] category The [usage
+                #   category](https://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.
+                # @param [Date] start_date 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.
+                # @param [Date] end_date 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.
+                # @param [Boolean] include_subaccounts 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.
                 # @param [Integer] limit Upper limit for the number of records to return. stream()
                 #    guarantees to never return more than limit.  Default is no limit
                 # @param [Integer] page_size Number of records to fetch per request, when
@@ -40,11 +55,12 @@ module Twilio
                 #    but a limit is defined, stream() will attempt to read the limit with the most
                 #    efficient page size, i.e. min(limit, 1000)
                 # @return [Array] Array of up to limit results
-                def list(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
+                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
@@ -54,9 +70,22 @@ module Twilio
                 # Streams TodayInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [today.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [today.Category] category The [usage
+                #   category](https://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.
+                # @param [Date] start_date 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.
+                # @param [Date] end_date 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.
+                # @param [Boolean] include_subaccounts 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.
                 # @param [Integer] limit Upper limit for the number of records to return. stream()
                 #    guarantees to never return more than limit. Default is no limit.
                 # @param [Integer] page_size Number of records to fetch per request, when
@@ -64,13 +93,14 @@ module Twilio
                 #    but a limit is defined, stream() will attempt to read the limit with the most
                 #    efficient page size, i.e. min(limit, 1000)
                 # @return [Enumerable] Enumerable that will yield up to limit results
-                def stream(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
+                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],
                   )
 
@@ -84,7 +114,7 @@ module Twilio
                 def each
                   limits = @version.read_limits
 
-                  page = self.page(page_size: limits[:page_size])
+                  page = self.page(page_size: limits[:page_size], )
 
                   @version.stream(page,
                                   limit: limits[:limit],
@@ -94,18 +124,32 @@ module Twilio
                 ##
                 # Retrieve a single page of TodayInstance records from the API.
                 # Request is executed immediately.
-                # @param [today.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [today.Category] category The [usage
+                #   category](https://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.
+                # @param [Date] start_date 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.
+                # @param [Date] end_date 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.
+                # @param [Boolean] include_subaccounts 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.
                 # @param [String] page_token PageToken provided by the API
                 # @param [Integer] page_number Page Number, this value is simply for client state
                 # @param [Integer] page_size Number of records to return, defaults to 50
                 # @return [Page] Page of TodayInstance
-                def page(category: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                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,
@@ -157,7 +201,7 @@ module Twilio
                 # @param [Hash] payload Payload response from the API
                 # @return [TodayInstance] TodayInstance
                 def get_instance(payload)
-                  TodayInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                  TodayInstance.new(@version, payload, account_sid: @solution[:account_sid], )
                 end
 
                 ##
@@ -182,6 +226,7 @@ module Twilio
                   @properties = {
                       'account_sid' => payload['account_sid'],
                       'api_version' => payload['api_version'],
+                      'as_of' => payload['as_of'],
                       'category' => payload['category'],
                       'count' => payload['count'],
                       'count_unit' => payload['count_unit'],
@@ -198,85 +243,91 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The SID of the Account accrued the usage
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] The api_version
+                # @return [String] The API version used to create the resource
                 def api_version
                   @properties['api_version']
                 end
 
                 ##
-                # @return [today.Category] The category
+                # @return [String] Usage records up to date as of this timestamp
+                def as_of
+                  @properties['as_of']
+                end
+
+                ##
+                # @return [today.Category] The category of usage
                 def category
                   @properties['category']
                 end
 
                 ##
-                # @return [String] The count
+                # @return [String] The number of usage events
                 def count
                   @properties['count']
                 end
 
                 ##
-                # @return [String] The count_unit
+                # @return [String] The units in which count is measured
                 def count_unit
                   @properties['count_unit']
                 end
 
                 ##
-                # @return [String] The description
+                # @return [String] A plain-language description of the usage category
                 def description
                   @properties['description']
                 end
 
                 ##
-                # @return [Date] The end_date
+                # @return [Date] The last date for which usage is included in the UsageRecord
                 def end_date
                   @properties['end_date']
                 end
 
                 ##
-                # @return [String] The price
+                # @return [String] The total price of the usage
                 def price
                   @properties['price']
                 end
 
                 ##
-                # @return [String] The price_unit
+                # @return [String] The currency in which `price` is measured
                 def price_unit
                   @properties['price_unit']
                 end
 
                 ##
-                # @return [Date] The start_date
+                # @return [Date] The first date for which usage is included in this UsageRecord
                 def start_date
                   @properties['start_date']
                 end
 
                 ##
-                # @return [String] The subresource_uris
+                # @return [String] A list of related resources identified by their relative URIs
                 def subresource_uris
                   @properties['subresource_uris']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI of the resource, relative to `https://api.twilio.com`
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [String] The usage
+                # @return [String] The amount of usage
                 def usage
                   @properties['usage']
                 end
 
                 ##
-                # @return [String] The usage_unit
+                # @return [String] The units in which usage is measured
                 def usage_unit
                   @properties['usage_unit']
                 end

data/lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -30,9 +32,22 @@ module Twilio
                 # Lists YearlyInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [yearly.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yearly.Category] category The [usage
+                #   category](https://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.
+                # @param [Date] start_date 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.
+                # @param [Date] end_date 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.
+                # @param [Boolean] include_subaccounts 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.
                 # @param [Integer] limit Upper limit for the number of records to return. stream()
                 #    guarantees to never return more than limit.  Default is no limit
                 # @param [Integer] page_size Number of records to fetch per request, when
@@ -40,11 +55,12 @@ module Twilio
                 #    but a limit is defined, stream() will attempt to read the limit with the most
                 #    efficient page size, i.e. min(limit, 1000)
                 # @return [Array] Array of up to limit results
-                def list(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
+                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
@@ -54,9 +70,22 @@ module Twilio
                 # Streams YearlyInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [yearly.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yearly.Category] category The [usage
+                #   category](https://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.
+                # @param [Date] start_date 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.
+                # @param [Date] end_date 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.
+                # @param [Boolean] include_subaccounts 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.
                 # @param [Integer] limit Upper limit for the number of records to return. stream()
                 #    guarantees to never return more than limit. Default is no limit.
                 # @param [Integer] page_size Number of records to fetch per request, when
@@ -64,13 +93,14 @@ module Twilio
                 #    but a limit is defined, stream() will attempt to read the limit with the most
                 #    efficient page size, i.e. min(limit, 1000)
                 # @return [Enumerable] Enumerable that will yield up to limit results
-                def stream(category: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
+                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],
                   )
 
@@ -84,7 +114,7 @@ module Twilio
                 def each
                   limits = @version.read_limits
 
-                  page = self.page(page_size: limits[:page_size])
+                  page = self.page(page_size: limits[:page_size], )
 
                   @version.stream(page,
                                   limit: limits[:limit],
@@ -94,18 +124,32 @@ module Twilio
                 ##
                 # Retrieve a single page of YearlyInstance records from the API.
                 # Request is executed immediately.
-                # @param [yearly.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yearly.Category] category The [usage
+                #   category](https://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.
+                # @param [Date] start_date 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.
+                # @param [Date] end_date 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.
+                # @param [Boolean] include_subaccounts 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.
                 # @param [String] page_token PageToken provided by the API
                 # @param [Integer] page_number Page Number, this value is simply for client state
                 # @param [Integer] page_size Number of records to return, defaults to 50
                 # @return [Page] Page of YearlyInstance
-                def page(category: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                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,
@@ -157,7 +201,7 @@ module Twilio
                 # @param [Hash] payload Payload response from the API
                 # @return [YearlyInstance] YearlyInstance
                 def get_instance(payload)
-                  YearlyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                  YearlyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
                 end
 
                 ##
@@ -182,6 +226,7 @@ module Twilio
                   @properties = {
                       'account_sid' => payload['account_sid'],
                       'api_version' => payload['api_version'],
+                      'as_of' => payload['as_of'],
                       'category' => payload['category'],
                       'count' => payload['count'],
                       'count_unit' => payload['count_unit'],
@@ -198,85 +243,91 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The SID of the Account accrued the usage
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] The api_version
+                # @return [String] The API version used to create the resource
                 def api_version
                   @properties['api_version']
                 end
 
                 ##
-                # @return [yearly.Category] The category
+                # @return [String] Usage records up to date as of this timestamp
+                def as_of
+                  @properties['as_of']
+                end
+
+                ##
+                # @return [yearly.Category] The category of usage
                 def category
                   @properties['category']
                 end
 
                 ##
-                # @return [String] The count
+                # @return [String] The number of usage events
                 def count
                   @properties['count']
                 end
 
                 ##
-                # @return [String] The count_unit
+                # @return [String] The units in which count is measured
                 def count_unit
                   @properties['count_unit']
                 end
 
                 ##
-                # @return [String] The description
+                # @return [String] A plain-language description of the usage category
                 def description
                   @properties['description']
                 end
 
                 ##
-                # @return [Date] The end_date
+                # @return [Date] The last date for which usage is included in the UsageRecord
                 def end_date
                   @properties['end_date']
                 end
 
                 ##
-                # @return [String] The price
+                # @return [String] The total price of the usage
                 def price
                   @properties['price']
                 end
 
                 ##
-                # @return [String] The price_unit
+                # @return [String] The currency in which `price` is measured
                 def price_unit
                   @properties['price_unit']
                 end
 
                 ##
-                # @return [Date] The start_date
+                # @return [Date] The first date for which usage is included in this UsageRecord
                 def start_date
                   @properties['start_date']
                 end
 
                 ##
-                # @return [String] The subresource_uris
+                # @return [String] A list of related resources identified by their relative URIs
                 def subresource_uris
                   @properties['subresource_uris']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI of the resource, relative to `https://api.twilio.com`
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [String] The usage
+                # @return [String] The amount of usage
                 def usage
                   @properties['usage']
                 end
 
                 ##
-                # @return [String] The usage_unit
+                # @return [String] The units in which usage is measured
                 def usage_unit
                   @properties['usage_unit']
                 end