twilio-ruby 5.19.0 → 5.74.2

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -32,17 +32,22 @@ module Twilio
                 # Lists ThisMonthInstance records from the API as a list.
                 # Unlike stream(), this operation is eager and will load `limit` records into
                 # memory before returning.
-                # @param [this_month.Category] category Only include usage of this [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [this_month.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.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `StartDate=-30days` will make
-                #   `StartDate` be 30 days before today.
-                # @param [Date] end_date Only include usage that has occurred on or before this
-                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `EndDate=+30days` will make
-                #   `EndDate` be 30 days from today.
-                # @param [Boolean] include_subaccounts The include_subaccounts
+                #   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
@@ -65,17 +70,22 @@ module Twilio
                 # Streams ThisMonthInstance records from the API as an Enumerable.
                 # This operation lazily loads records as efficiently as possible until the limit
                 # is reached.
-                # @param [this_month.Category] category Only include usage of this [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [this_month.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.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `StartDate=-30days` will make
-                #   `StartDate` be 30 days before today.
-                # @param [Date] end_date Only include usage that has occurred on or before this
-                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `EndDate=+30days` will make
-                #   `EndDate` be 30 days from today.
-                # @param [Boolean] include_subaccounts The include_subaccounts
+                #   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
@@ -114,17 +124,22 @@ module Twilio
                 ##
                 # Retrieve a single page of ThisMonthInstance records from the API.
                 # Request is executed immediately.
-                # @param [this_month.Category] category Only include usage of this [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @param [this_month.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.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `StartDate=-30days` will make
-                #   `StartDate` be 30 days before today.
-                # @param [Date] end_date Only include usage that has occurred on or before this
-                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `EndDate=+30days` will make
-                #   `EndDate` be 30 days from today.
-                # @param [Boolean] include_subaccounts The include_subaccounts
+                #   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
@@ -139,11 +154,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   ThisMonthPage.new(@version, response, @solution)
                 end
 
@@ -211,12 +224,13 @@ 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'],
                       'description' => payload['description'],
                       'end_date' => Twilio.deserialize_iso8601_date(payload['end_date']),
-                      'price' => payload['price'].to_f,
+                      'price' => payload['price'] == nil ? payload['price'] : payload['price'].to_f,
                       'price_unit' => payload['price_unit'],
                       'start_date' => Twilio.deserialize_iso8601_date(payload['start_date']),
                       'subresource_uris' => payload['subresource_uris'],
@@ -227,85 +241,91 @@ 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 [this_month.Category] The category of usage.
+                # @return [String] Usage records up to date as of this timestamp
+                def as_of
+                  @properties['as_of']
+                end
+
+                ##
+                # @return [this_month.Category] The category of usage
                 def category
                   @properties['category']
                 end
 
                 ##
-                # @return [String] The number of usage events.
+                # @return [String] The number of usage events
                 def count
                   @properties['count']
                 end
 
                 ##
-                # @return [String] The units 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 for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
+                # @return [Date] The last date for which usage is included in the UsageRecord
                 def end_date
                   @properties['end_date']
                 end
 
                 ##
-                # @return [String] The total price of the usage, in the currency associated with the account.
+                # @return [String] The total price of the usage
                 def price
                   @properties['price']
                 end
 
                 ##
-                # @return [String] The currency in which Price is measured, in ISO 4127 format.
+                # @return [String] The currency in which `price` is measured
                 def price_unit
                   @properties['price_unit']
                 end
 
                 ##
-                # @return [Date] The first date for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
+                # @return [Date] The first date for which usage is included in this UsageRecord
                 def start_date
                   @properties['start_date']
                 end
 
                 ##
-                # @return [String] Subresource 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 that returns only this UsageRecord, relative to https://api.
+                # @return [String] The URI of the resource, relative to `https://api.twilio.com`
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [String] The amount of billed usage.
+                # @return [String] The amount of usage
                 def usage
                   @properties['usage']
                 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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -32,17 +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 Only include usage of this [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @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.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `StartDate=-30days` will make
-                #   `StartDate` be 30 days before today.
-                # @param [Date] end_date Only include usage that has occurred on or before this
-                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `EndDate=+30days` will make
-                #   `EndDate` be 30 days from today.
-                # @param [Boolean] include_subaccounts The include_subaccounts
+                #   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
@@ -65,17 +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 Only include usage of this [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @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.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `StartDate=-30days` will make
-                #   `StartDate` be 30 days before today.
-                # @param [Date] end_date Only include usage that has occurred on or before this
-                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `EndDate=+30days` will make
-                #   `EndDate` be 30 days from today.
-                # @param [Boolean] include_subaccounts The include_subaccounts
+                #   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
@@ -114,17 +124,22 @@ module Twilio
                 ##
                 # Retrieve a single page of TodayInstance records from the API.
                 # Request is executed immediately.
-                # @param [today.Category] category Only include usage of this [usage
-                #   category](https://www.twilio.com/docs/api/rest/usage-records#usage-categories).
+                # @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.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `StartDate=-30days` will make
-                #   `StartDate` be 30 days before today.
-                # @param [Date] end_date Only include usage that has occurred on or before this
-                #   date.  Format is YYYY-MM-DD.  All dates are in GMT.  As a convenience, you can
-                #   also specify offsets to today.  For example, `EndDate=+30days` will make
-                #   `EndDate` be 30 days from today.
-                # @param [Boolean] include_subaccounts The include_subaccounts
+                #   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
@@ -139,11 +154,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   TodayPage.new(@version, response, @solution)
                 end
 
@@ -211,12 +224,13 @@ 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'],
                       'description' => payload['description'],
                       'end_date' => Twilio.deserialize_iso8601_date(payload['end_date']),
-                      'price' => payload['price'].to_f,
+                      'price' => payload['price'] == nil ? payload['price'] : payload['price'].to_f,
                       'price_unit' => payload['price_unit'],
                       'start_date' => Twilio.deserialize_iso8601_date(payload['start_date']),
                       'subresource_uris' => payload['subresource_uris'],
@@ -227,85 +241,91 @@ 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 [today.Category] The category of usage.
+                # @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 number of usage events.
+                # @return [String] The number of usage events
                 def count
                   @properties['count']
                 end
 
                 ##
-                # @return [String] The units 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 for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
+                # @return [Date] The last date for which usage is included in the UsageRecord
                 def end_date
                   @properties['end_date']
                 end
 
                 ##
-                # @return [String] The total price of the usage, in the currency associated with the account.
+                # @return [String] The total price of the usage
                 def price
                   @properties['price']
                 end
 
                 ##
-                # @return [String] The currency in which Price is measured, in ISO 4127 format.
+                # @return [String] The currency in which `price` is measured
                 def price_unit
                   @properties['price_unit']
                 end
 
                 ##
-                # @return [Date] The first date for which usage is included in this UsageRecord, formatted as YYYY-MM-DD.
+                # @return [Date] The first date for which usage is included in this UsageRecord
                 def start_date
                   @properties['start_date']
                 end
 
                 ##
-                # @return [String] Subresource 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 that returns only this UsageRecord, relative to https://api.
+                # @return [String] The URI of the resource, relative to `https://api.twilio.com`
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # @return [String] The amount of billed usage.
+                # @return [String] The amount of usage
                 def usage
                   @properties['usage']
                 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