twilio-ruby 5.20.0 → 5.47.0

data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,10 +16,11 @@ module Twilio
               ##
               # Initialize the AddOnResultList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the Account responsible for this
-              #   recording.
-              # @param [String] reference_sid A 34 character string that uniquely identifies the
-              #   recording to which this result belongs.
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   Recording AddOnResult resource.
+              # @param [String] reference_sid The SID of the recording to which the AddOnResult
+              #   resource belongs.
               # @return [AddOnResultList] AddOnResultList
               def initialize(version, account_sid: nil, reference_sid: nil)
                 super(version)
@@ -90,11 +91,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 AddOnResultPage.new(@version, response, @solution)
               end
 
@@ -156,9 +155,13 @@ module Twilio
               ##
               # Initialize the AddOnResultContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] reference_sid The reference_sid
-              # @param [String] sid The result Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   Recording AddOnResult resource to fetch.
+              # @param [String] reference_sid The SID of the recording to which the result to
+              #   fetch belongs.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording AddOnResult resource to fetch.
               # @return [AddOnResultContext] AddOnResultContext
               def initialize(version, account_sid, reference_sid, sid)
                 super(version)
@@ -172,16 +175,10 @@ module Twilio
               end
 
               ##
-              # Fetch a AddOnResultInstance
+              # Fetch the AddOnResultInstance
               # @return [AddOnResultInstance] Fetched AddOnResultInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 AddOnResultInstance.new(
                     @version,
@@ -193,10 +190,10 @@ module Twilio
               end
 
               ##
-              # Deletes the AddOnResultInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the AddOnResultInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -234,6 +231,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.AddOnResultContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.AddOnResultContext #{context}>"
+              end
             end
 
             class AddOnResultInstance < InstanceResource
@@ -241,11 +245,13 @@ module Twilio
               # Initialize the AddOnResultInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The unique id of the Account responsible for this
-              #   recording.
-              # @param [String] reference_sid A 34 character string that uniquely identifies the
-              #   recording to which this result belongs.
-              # @param [String] sid The result Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   Recording AddOnResult resource.
+              # @param [String] reference_sid The SID of the recording to which the AddOnResult
+              #   resource belongs.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Recording AddOnResult resource to fetch.
               # @return [AddOnResultInstance] AddOnResultInstance
               def initialize(version, payload, account_sid: nil, reference_sid: nil, sid: nil)
                 super(version)
@@ -290,75 +296,75 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this result
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The unique sid that identifies this account
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [add_on_result.Status] The status of this result.
+              # @return [add_on_result.Status] The status of the result
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] A string that uniquely identifies the Add-on.
+              # @return [String] The SID of the Add-on to which the result belongs
               def add_on_sid
                 @properties['add_on_sid']
               end
 
               ##
-              # @return [String] A string that uniquely identifies the Add-on configuration.
+              # @return [String] The SID of the Add-on configuration
               def add_on_configuration_sid
                 @properties['add_on_configuration_sid']
               end
 
               ##
-              # @return [Time] The date this resource was created
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this resource was last updated
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Time] The date this result was completed.
+              # @return [Time] The date and time in GMT that the result was completed
               def date_completed
                 @properties['date_completed']
               end
 
               ##
-              # @return [String] A string that uniquely identifies the recording.
+              # @return [String] The SID of the recording to which the AddOnResult resource belongs
               def reference_sid
                 @properties['reference_sid']
               end
 
               ##
-              # @return [String] A dictionary of URIs for related resources
+              # @return [String] A list of related resources identified by their relative URIs
               def subresource_uris
                 @properties['subresource_uris']
               end
 
               ##
-              # Fetch a AddOnResultInstance
+              # Fetch the AddOnResultInstance
               # @return [AddOnResultInstance] Fetched AddOnResultInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the AddOnResultInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the AddOnResultInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,12 +17,13 @@ module Twilio
                 ##
                 # Initialize the PayloadList
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The unique id of the Account responsible for the
-                #   recording.
-                # @param [String] reference_sid A 34 character string that uniquely identifies the
-                #   recording to which this payload belongs.
-                # @param [String] add_on_result_sid A 34 character string that uniquely identifies
-                #   this result to which this payload belongs.
+                # @param [String] account_sid The SID of the
+                #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+                #   Recording AddOnResult Payload resource.
+                # @param [String] reference_sid The SID of the recording to which the AddOnResult
+                #   resource that contains the payload belongs.
+                # @param [String] add_on_result_sid The SID of the AddOnResult to which the
+                #   payload belongs.
                 # @return [PayloadList] PayloadList
                 def initialize(version, account_sid: nil, reference_sid: nil, add_on_result_sid: nil)
                   super(version)
@@ -97,11 +98,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   PayloadPage.new(@version, response, @solution)
                 end
 
@@ -164,10 +163,15 @@ module Twilio
                 ##
                 # Initialize the PayloadContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The account_sid
-                # @param [String] reference_sid The reference_sid
-                # @param [String] add_on_result_sid The add_on_result_sid
-                # @param [String] sid The paylod Sid that uniquely identifies this resource
+                # @param [String] account_sid The SID of the
+                #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+                #   Recording AddOnResult Payload resource to fetch.
+                # @param [String] reference_sid The SID of the recording to which the AddOnResult
+                #   resource that contains the payload to fetch belongs.
+                # @param [String] add_on_result_sid The SID of the AddOnResult to which the
+                #   payload to fetch belongs.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   Recording AddOnResult Payload resource to fetch.
                 # @return [PayloadContext] PayloadContext
                 def initialize(version, account_sid, reference_sid, add_on_result_sid, sid)
                   super(version)
@@ -183,16 +187,10 @@ module Twilio
                 end
 
                 ##
-                # Fetch a PayloadInstance
+                # Fetch the PayloadInstance
                 # @return [PayloadInstance] Fetched PayloadInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   PayloadInstance.new(
                       @version,
@@ -205,10 +203,10 @@ module Twilio
                 end
 
                 ##
-                # Deletes the PayloadInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the PayloadInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
-                  @version.delete('delete', @uri)
+                   @version.delete('DELETE', @uri)
                 end
 
                 ##
@@ -217,6 +215,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Api.V2010.PayloadContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Api.V2010.PayloadContext #{context}>"
+                end
               end
 
               class PayloadInstance < InstanceResource
@@ -224,13 +229,15 @@ module Twilio
                 # Initialize the PayloadInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] account_sid The unique id of the Account responsible for the
-                #   recording.
-                # @param [String] reference_sid A 34 character string that uniquely identifies the
-                #   recording to which this payload belongs.
-                # @param [String] add_on_result_sid A 34 character string that uniquely identifies
-                #   this result to which this payload belongs.
-                # @param [String] sid The paylod Sid that uniquely identifies this resource
+                # @param [String] account_sid The SID of the
+                #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+                #   Recording AddOnResult Payload resource.
+                # @param [String] reference_sid The SID of the recording to which the AddOnResult
+                #   resource that contains the payload belongs.
+                # @param [String] add_on_result_sid The SID of the AddOnResult to which the
+                #   payload belongs.
+                # @param [String] sid The Twilio-provided string that uniquely identifies the
+                #   Recording AddOnResult Payload resource to fetch.
                 # @return [PayloadInstance] PayloadInstance
                 def initialize(version, payload, account_sid: nil, reference_sid: nil, add_on_result_sid: nil, sid: nil)
                   super(version)
@@ -278,81 +285,81 @@ module Twilio
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies this payload
+                # @return [String] The unique string that identifies the resource
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the result
+                # @return [String] The SID of the AddOnResult to which the payload belongs
                 def add_on_result_sid
                   @properties['add_on_result_sid']
                 end
 
                 ##
-                # @return [String] The unique sid that identifies this account
+                # @return [String] The SID of the Account that created the resource
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] A string that describes the payload.
+                # @return [String] The string that describes the payload
                 def label
                   @properties['label']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the Add-on.
+                # @return [String] The SID of the Add-on to which the result belongs
                 def add_on_sid
                   @properties['add_on_sid']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the Add-on configuration.
+                # @return [String] The SID of the Add-on configuration
                 def add_on_configuration_sid
                   @properties['add_on_configuration_sid']
                 end
 
                 ##
-                # @return [String] The MIME type of the payload.
+                # @return [String] The MIME type of the payload
                 def content_type
                   @properties['content_type']
                 end
 
                 ##
-                # @return [Time] The date this resource was created
+                # @return [Time] The RFC 2822 date and time in GMT that the resource was created
                 def date_created
                   @properties['date_created']
                 end
 
                 ##
-                # @return [Time] The date this resource was last updated
+                # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
                 def date_updated
                   @properties['date_updated']
                 end
 
                 ##
-                # @return [String] A string that uniquely identifies the recording.
+                # @return [String] The SID of the recording to which the AddOnResult resource that contains the payload belongs
                 def reference_sid
                   @properties['reference_sid']
                 end
 
                 ##
-                # @return [String] A dictionary of URIs for related resources
+                # @return [String] A list of related resources identified by their relative URIs
                 def subresource_uris
                   @properties['subresource_uris']
                 end
 
                 ##
-                # Fetch a PayloadInstance
+                # Fetch the PayloadInstance
                 # @return [PayloadInstance] Fetched PayloadInstance
                 def fetch
                   context.fetch
                 end
 
                 ##
-                # Deletes the PayloadInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the PayloadInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
                   context.delete
                 end

data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,8 +16,12 @@ module Twilio
               ##
               # Initialize the TranscriptionList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] recording_sid The recording_sid
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   Transcription resource.
+              # @param [String] recording_sid The SID of the
+              #   {Recording}[https://www.twilio.com/docs/voice/api/recording] from which the
+              #   transcription was created.
               # @return [TranscriptionList] TranscriptionList
               def initialize(version, account_sid: nil, recording_sid: nil)
                 super(version)
@@ -88,11 +92,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 TranscriptionPage.new(@version, response, @solution)
               end
 
@@ -154,9 +156,14 @@ module Twilio
               ##
               # Initialize the TranscriptionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] recording_sid The recording_sid
-              # @param [String] sid The sid
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   Transcription resource to fetch.
+              # @param [String] recording_sid The SID of the
+              #   {Recording}[https://www.twilio.com/docs/voice/api/recording] that created the
+              #   transcription to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Transcription resource to fetch.
               # @return [TranscriptionContext] TranscriptionContext
               def initialize(version, account_sid, recording_sid, sid)
                 super(version)
@@ -167,16 +174,10 @@ module Twilio
               end
 
               ##
-              # Fetch a TranscriptionInstance
+              # Fetch the TranscriptionInstance
               # @return [TranscriptionInstance] Fetched TranscriptionInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 TranscriptionInstance.new(
                     @version,
@@ -188,10 +189,10 @@ module Twilio
               end
 
               ##
-              # Deletes the TranscriptionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the TranscriptionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -200,6 +201,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.TranscriptionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.TranscriptionContext #{context}>"
+              end
             end
 
             class TranscriptionInstance < InstanceResource
@@ -207,9 +215,14 @@ module Twilio
               # Initialize the TranscriptionInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The account_sid
-              # @param [String] recording_sid The recording_sid
-              # @param [String] sid The sid
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   Transcription resource.
+              # @param [String] recording_sid The SID of the
+              #   {Recording}[https://www.twilio.com/docs/voice/api/recording] from which the
+              #   transcription was created.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Transcription resource to fetch.
               # @return [TranscriptionInstance] TranscriptionInstance
               def initialize(version, payload, account_sid: nil, recording_sid: nil, sid: nil)
                 super(version)
@@ -257,93 +270,93 @@ module Twilio
               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 [String] The api_version
+              # @return [String] The API version used to create the transcription
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The duration
+              # @return [String] The duration of the transcribed audio in seconds.
               def duration
                 @properties['duration']
               end
 
               ##
-              # @return [String] The price
+              # @return [String] The charge for the transcription
               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 [String] The recording_sid
+              # @return [String] The SID that identifies the transcription's recording
               def recording_sid
                 @properties['recording_sid']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [transcription.Status] The status
+              # @return [transcription.Status] The status of the transcription
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The transcription_text
+              # @return [String] The text content of the transcription.
               def transcription_text
                 @properties['transcription_text']
               end
 
               ##
-              # @return [String] The type
+              # @return [String] The transcription type
               def type
                 @properties['type']
               end
 
               ##
-              # @return [String] The uri
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
-              # Fetch a TranscriptionInstance
+              # Fetch the TranscriptionInstance
               # @return [TranscriptionInstance] Fetched TranscriptionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the TranscriptionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the TranscriptionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end