transcription.rb in twilio-ruby-5.0.0

- old
+ new

@@ -67,16 +67,10 @@
 
             ##
             # When passed a block, yields TranscriptionInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @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                       not set will use
-            #  the default value of 50 records.                      If no page_size is defined
-            #                       but a limit is defined, stream() will attempt to read the
-            #                       limit with the most efficient page size, i.e. min(limit, 1000)
             def each
               limits = @version.read_limits
 
               page = self.page(
                   page_size: limits[:page_size],
@@ -132,12 +126,10 @@
             ##
             # Initialize the TranscriptionPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
-            #   transcription.
             # @return [TranscriptionPage] TranscriptionPage
             def initialize(version, response, solution)
               super(version, response)
 
               # Path Solution
@@ -254,11 +246,10 @@
             end
 
             ##
             # Generate an instance context for the instance, the context is capable of
             # performing various actions.  All instance actions are proxied to the context
-            # @param [Version] version Version that contains the resource
             # @return [TranscriptionContext] TranscriptionContext for this TranscriptionInstance
             def context
               unless @instance_context
                 @instance_context = TranscriptionContext.new(
                     @version,
@@ -267,57 +258,83 @@
                 )
               end
               @instance_context
             end
 
+            ##
+            # @return [String] The unique sid that identifies this account
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The api_version
             def api_version
               @properties['api_version']
             end
 
+            ##
+            # @return [Time] The date this resource was created
             def date_created
               @properties['date_created']
             end
 
+            ##
+            # @return [Time] The date this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
+            ##
+            # @return [String] The duration of the transcribed audio, in seconds.
             def duration
               @properties['duration']
             end
 
+            ##
+            # @return [String] The charge for this transcription
             def price
               @properties['price']
             end
 
+            ##
+            # @return [String] The currency in which Price is measured
             def price_unit
               @properties['price_unit']
             end
 
+            ##
+            # @return [String] The string that uniquely identifies the recording
             def recording_sid
               @properties['recording_sid']
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this transcription
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [transcription.Status] The status of the transcription
             def status
               @properties['status']
             end
 
+            ##
+            # @return [String] The text content of the transcription.
             def transcription_text
               @properties['transcription_text']
             end
 
+            ##
+            # @return [String] The type
             def type
               @properties['type']
             end
 
+            ##
+            # @return [String] The URI for this resource
             def uri
               @properties['uri']
             end
 
             ##
\ No newline at end of file