twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -30,9 +32,22 @@ module Twilio
                 # Lists YesterdayInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [yesterday.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yesterday.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 YesterdayInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [yesterday.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yesterday.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,27 +124,39 @@ module Twilio
                 ##
                 # Retrieve a single page of YesterdayInstance records from the API.
                 # Request is executed immediately.
-                # @param [yesterday.Category] category The category
-                # @param [Date] start_date The start_date
-                # @param [Date] end_date The end_date
+                # @param [yesterday.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 YesterdayInstance
-                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,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   YesterdayPage.new(@version, response, @solution)
                 end
 
@@ -157,7 +199,7 @@ module Twilio
                 # @param [Hash] payload Payload response from the API
                 # @return [YesterdayInstance] YesterdayInstance
                 def get_instance(payload)
-                  YesterdayInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                  YesterdayInstance.new(@version, payload, account_sid: @solution[:account_sid], )
                 end
 
                 ##
@@ -182,6 +224,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 +241,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 [yesterday.Category] The category
+                # @return [String] Usage records up to date as of this timestamp
+                def as_of
+                  @properties['as_of']
+                end
+
+                ##
+                # @return [yesterday.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.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -39,15 +41,22 @@ module Twilio
               # Lists RecordInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [yesterday.Category] category Only include usage of a given category
+              # @param [record.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. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, StartDate=-30days, which will make StartDate 30
-              #   days before today
-              # @param [Date] end_date Only include usage that has occurred on or after this
-              #   date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, EndDate=+30days, which will make EndDate 30 days
-              #   from today
+              #   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
@@ -55,11 +64,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
@@ -69,15 +79,22 @@ module Twilio
               # Streams RecordInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [yesterday.Category] category Only include usage of a given category
+              # @param [record.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. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, StartDate=-30days, which will make StartDate 30
-              #   days before today
-              # @param [Date] end_date Only include usage that has occurred on or after this
-              #   date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, EndDate=+30days, which will make EndDate 30 days
-              #   from today
+              #   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
@@ -85,13 +102,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],
                 )
 
@@ -105,7 +123,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],
@@ -115,33 +133,39 @@ module Twilio
               ##
               # Retrieve a single page of RecordInstance records from the API.
               # Request is executed immediately.
-              # @param [yesterday.Category] category Only include usage of a given category
+              # @param [record.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. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, StartDate=-30days, which will make StartDate 30
-              #   days before today
-              # @param [Date] end_date Only include usage that has occurred on or after this
-              #   date. Format is YYYY-MM-DD in GTM. As a convenience, you can also specify
-              #   offsets to today, for example, EndDate=+30days, which will make EndDate 30 days
-              #   from today
+              #   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 RecordInstance
-              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,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 RecordPage.new(@version, response, @solution)
               end
 
@@ -163,7 +187,7 @@ module Twilio
               # @return [AllTimeList]
               # @return [AllTimeContext]
               def all_time
-                @all_time ||= AllTimeList.new(@version, account_sid: @solution[:account_sid])
+                @all_time ||= AllTimeList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -171,7 +195,7 @@ module Twilio
               # @return [DailyList]
               # @return [DailyContext]
               def daily
-                @daily ||= DailyList.new(@version, account_sid: @solution[:account_sid])
+                @daily ||= DailyList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -179,7 +203,7 @@ module Twilio
               # @return [LastMonthList]
               # @return [LastMonthContext]
               def last_month
-                @last_month ||= LastMonthList.new(@version, account_sid: @solution[:account_sid])
+                @last_month ||= LastMonthList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -187,7 +211,7 @@ module Twilio
               # @return [MonthlyList]
               # @return [MonthlyContext]
               def monthly
-                @monthly ||= MonthlyList.new(@version, account_sid: @solution[:account_sid])
+                @monthly ||= MonthlyList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -195,7 +219,7 @@ module Twilio
               # @return [ThisMonthList]
               # @return [ThisMonthContext]
               def this_month
-                @this_month ||= ThisMonthList.new(@version, account_sid: @solution[:account_sid])
+                @this_month ||= ThisMonthList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -203,7 +227,7 @@ module Twilio
               # @return [TodayList]
               # @return [TodayContext]
               def today
-                @today ||= TodayList.new(@version, account_sid: @solution[:account_sid])
+                @today ||= TodayList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -211,7 +235,7 @@ module Twilio
               # @return [YearlyList]
               # @return [YearlyContext]
               def yearly
-                @yearly ||= YearlyList.new(@version, account_sid: @solution[:account_sid])
+                @yearly ||= YearlyList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -219,7 +243,7 @@ module Twilio
               # @return [YesterdayList]
               # @return [YesterdayContext]
               def yesterday
-                @yesterday ||= YesterdayList.new(@version, account_sid: @solution[:account_sid])
+                @yesterday ||= YesterdayList.new(@version, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -248,7 +272,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [RecordInstance] RecordInstance
               def get_instance(payload)
-                RecordInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                RecordInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -273,6 +297,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'],
@@ -289,43 +314,49 @@ module Twilio
               end
 
               ##
-              # @return [String] The Account that accrued the usage
+              # @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 [yesterday.Category] The category of usage
+              # @return [String] Usage records up to date as of this timestamp
+              def as_of
+                @properties['as_of']
+              end
+
+              ##
+              # @return [record.Category] The category of usage
               def category
                 @properties['category']
               end
 
               ##
-              # @return [String] The number of usage events (e.g. the number of calls).
+              # @return [String] The number of usage events
               def count
                 @properties['count']
               end
 
               ##
-              # @return [String] The unit in which `Count` is measured
+              # @return [String] The units in which count is measured
               def count_unit
                 @properties['count_unit']
               end
 
               ##
-              # @return [String] A human-readable description of the usage category.
+              # @return [String] A plain-language description of the usage category
               def description
                 @properties['description']
               end
 
               ##
-              # @return [Date] The last date usage is included in this record
+              # @return [Date] The last date for which usage is included in the UsageRecord
               def end_date
                 @properties['end_date']
               end
@@ -337,25 +368,25 @@ module Twilio
               end
 
               ##
-              # @return [String] The currency in which `Price` is measured
+              # @return [String] The currency in which `price` is measured
               def price_unit
                 @properties['price_unit']
               end
 
               ##
-              # @return [Date] The first date usage is included in this record
+              # @return [Date] The first date for which usage is included in this UsageRecord
               def start_date
                 @properties['start_date']
               end
 
               ##
-              # @return [String] Subresources Uris for this UsageRecord
+              # @return [String] A list of related resources identified by their relative URIs
               def subresource_uris
                 @properties['subresource_uris']
               end
 
               ##
-              # @return [String] The URI for this resource
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
@@ -367,7 +398,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The units in which `Usage` is measured
+              # @return [String] The units in which usage is measured
               def usage_unit
                 @properties['usage_unit']
               end