twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/wireless/v1/sim/usage_record.rb

@@ -3,19 +3,21 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     class Wireless < Domain
       class V1 < Version
         class SimContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UsageRecordList < ListResource
             ##
             # Initialize the UsageRecordList
             # @param [Version] version Version that contains the resource
-            # @param [String] sim_sid The sim_sid
+            # @param [String] sim_sid The SID of the {Sim
+            #   resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that this Usage
+            #   Record is for.
             # @return [UsageRecordList] UsageRecordList
             def initialize(version, sim_sid: nil)
               super(version)
@@ -29,9 +31,15 @@ module Twilio
             # Lists UsageRecordInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Time] end_ The end
-            # @param [Time] start The start
-            # @param [usage_record.Granularity] granularity The granularity
+            # @param [Time] end_ Only include usage that occurred on or before this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is the current time.
+            # @param [Time] start Only include usage that has occurred on or after this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is one month before the `end` parameter value.
+            # @param [usage_record.Granularity] granularity How to summarize the usage by
+            #   time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of
+            #   `all` returns one Usage Record that describes the usage for the entire period.
             # @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
@@ -53,9 +61,15 @@ module Twilio
             # Streams UsageRecordInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] end_ The end
-            # @param [Time] start The start
-            # @param [usage_record.Granularity] granularity The granularity
+            # @param [Time] end_ Only include usage that occurred on or before this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is the current time.
+            # @param [Time] start Only include usage that has occurred on or after this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is one month before the `end` parameter value.
+            # @param [usage_record.Granularity] granularity How to summarize the usage by
+            #   time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of
+            #   `all` returns one Usage Record that describes the usage for the entire period.
             # @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
@@ -66,7 +80,7 @@ module Twilio
             def stream(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(end_: end_, start: start, granularity: granularity, page_size: limits[:page_size])
+              page = self.page(end_: end_, start: start, granularity: granularity, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -78,7 +92,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],
@@ -88,9 +102,15 @@ module Twilio
             ##
             # Retrieve a single page of UsageRecordInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] end_ The end
-            # @param [Time] start The start
-            # @param [usage_record.Granularity] granularity The granularity
+            # @param [Time] end_ Only include usage that occurred on or before this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is the current time.
+            # @param [Time] start Only include usage that has occurred on or after this date,
+            #   specified in {ISO 8601}[https://www.iso.org/iso-8601-date-and-time-format.html].
+            #   The default is one month before the `end` parameter value.
+            # @param [usage_record.Granularity] granularity How to summarize the usage by
+            #   time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of
+            #   `all` returns one Usage Record that describes the usage for the entire period.
             # @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
@@ -104,11 +124,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               UsageRecordPage.new(@version, response, @solution)
             end
 
@@ -132,8 +150,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UsageRecordPage < Page
             ##
             # Initialize the UsageRecordPage
@@ -153,7 +169,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [UsageRecordInstance] UsageRecordInstance
             def get_instance(payload)
-              UsageRecordInstance.new(@version, payload, sim_sid: @solution[:sim_sid])
+              UsageRecordInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
             end
 
             ##
@@ -163,14 +179,14 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class UsageRecordInstance < InstanceResource
             ##
             # Initialize the UsageRecordInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sim_sid The sim_sid
+            # @param [String] sim_sid The SID of the {Sim
+            #   resource}[https://www.twilio.com/docs/wireless/api/sim-resource] that this Usage
+            #   Record is for.
             # @return [UsageRecordInstance] UsageRecordInstance
             def initialize(version, payload, sim_sid: nil)
               super(version)
@@ -186,31 +202,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The sim_sid
+            # @return [String] The SID of the Sim resource that this Usage Record is for
             def sim_sid
               @properties['sim_sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Hash] The period
+            # @return [Hash] The time period for which the usage is reported
             def period
               @properties['period']
             end
 
             ##
-            # @return [Hash] The commands
+            # @return [Hash] An object that describes the SIM's usage of Commands during the specified period
             def commands
               @properties['commands']
             end
 
             ##
-            # @return [Hash] The data
+            # @return [Hash] An object that describes the SIM's data usage during the specified period
             def data
               @properties['data']
             end