twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the RecordingList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
-            #   recording.
+            # @param [String] account_sid The SID of the
+            #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+            #   Recording resource.
             # @return [RecordingList] RecordingList
             def initialize(version, account_sid: nil)
               super(version)
@@ -28,11 +31,14 @@ module Twilio
             # Lists RecordingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [String] call_sid Only show recordings made during the call given by the
-            #   indicated sid
+            # @param [Time] date_created_before Only include recordings that were created on this date
+            # @param [Time] date_created Only include recordings that were created on this date
+            # @param [Time] date_created_after Only include recordings that were created on this date
+            # @param [String] call_sid The
+            #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources
+            #   to read.
+            # @param [String] conference_sid The Conference SID that identifies the conference
+            #   associated with the recording to read.
             # @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,12 +46,13 @@ 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(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, limit: nil, page_size: nil)
+            def list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil)
               self.stream(
                   date_created_before: date_created_before,
                   date_created: date_created,
                   date_created_after: date_created_after,
                   call_sid: call_sid,
+                  conference_sid: conference_sid,
                   limit: limit,
                   page_size: page_size
               ).entries
@@ -55,11 +62,14 @@ module Twilio
             # Streams RecordingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [String] call_sid Only show recordings made during the call given by the
-            #   indicated sid
+            # @param [Time] date_created_before Only include recordings that were created on this date
+            # @param [Time] date_created Only include recordings that were created on this date
+            # @param [Time] date_created_after Only include recordings that were created on this date
+            # @param [String] call_sid The
+            #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources
+            #   to read.
+            # @param [String] conference_sid The Conference SID that identifies the conference
+            #   associated with the recording to read.
             # @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
@@ -67,7 +77,7 @@ 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(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, limit: nil, page_size: nil)
+            def stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
               page = self.page(
@@ -75,6 +85,7 @@ module Twilio
                   date_created: date_created,
                   date_created_after: date_created_after,
                   call_sid: call_sid,
+                  conference_sid: conference_sid,
                   page_size: limits[:page_size],
               )
 
@@ -88,7 +99,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],
@@ -98,30 +109,32 @@ module Twilio
             ##
             # Retrieve a single page of RecordingInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [String] call_sid Only show recordings made during the call given by the
-            #   indicated sid
+            # @param [Time] date_created_before Only include recordings that were created on this date
+            # @param [Time] date_created Only include recordings that were created on this date
+            # @param [Time] date_created_after Only include recordings that were created on this date
+            # @param [String] call_sid The
+            #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resources
+            #   to read.
+            # @param [String] conference_sid The Conference SID that identifies the conference
+            #   associated with the recording to read.
             # @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 RecordingInstance
-            def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'DateCreated<' => Twilio.serialize_iso8601_datetime(date_created_before),
                   'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                   'DateCreated>' => Twilio.serialize_iso8601_datetime(date_created_after),
                   'CallSid' => call_sid,
+                  'ConferenceSid' => conference_sid,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               RecordingPage.new(@version, response, @solution)
             end
 
@@ -164,7 +177,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [RecordingInstance] RecordingInstance
             def get_instance(payload)
-              RecordingInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              RecordingInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -178,14 +191,17 @@ module Twilio
             ##
             # Initialize the RecordingContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The recording 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 resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Recording resource to fetch.
             # @return [RecordingContext] RecordingContext
             def initialize(version, account_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {account_sid: account_sid, sid: sid}
+              @solution = {account_sid: account_sid, sid: sid, }
               @uri = "/Accounts/#{@solution[:account_sid]}/Recordings/#{@solution[:sid]}.json"
 
               # Dependents
@@ -194,25 +210,19 @@ module Twilio
             end
 
             ##
-            # Fetch a RecordingInstance
+            # Fetch the RecordingInstance
             # @return [RecordingInstance] Fetched RecordingInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
-
-              RecordingInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              RecordingInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the RecordingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -223,7 +233,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return TranscriptionContext.new(@version, @solution[:account_sid], @solution[:sid], sid)
+                return TranscriptionContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
               end
 
               unless @transcriptions
@@ -245,7 +255,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return AddOnResultContext.new(@version, @solution[:account_sid], @solution[:sid], sid)
+                return AddOnResultContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
               end
 
               unless @add_on_results
@@ -265,6 +275,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.RecordingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.RecordingContext #{context}>"
+            end
           end
 
           class RecordingInstance < InstanceResource
@@ -272,9 +289,11 @@ module Twilio
             # Initialize the RecordingInstance
             # @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] sid The recording 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 resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Recording resource to fetch.
             # @return [RecordingInstance] RecordingInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -284,8 +303,10 @@ module Twilio
                   'account_sid' => payload['account_sid'],
                   'api_version' => payload['api_version'],
                   'call_sid' => payload['call_sid'],
+                  'conference_sid' => payload['conference_sid'],
                   'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                   'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                  'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
                   'duration' => payload['duration'],
                   'sid' => payload['sid'],
                   'price' => payload['price'],
@@ -293,14 +314,15 @@ module Twilio
                   'status' => payload['status'],
                   'channels' => payload['channels'].to_i,
                   'source' => payload['source'],
+                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
                   'uri' => payload['uri'],
                   'encryption_details' => payload['encryption_details'],
-                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                  'subresource_uris' => payload['subresource_uris'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -309,111 +331,129 @@ module Twilio
             # @return [RecordingContext] RecordingContext for this RecordingInstance
             def context
               unless @instance_context
-                @instance_context = RecordingContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = RecordingContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             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] The version of the API in use during the recording.
+            # @return [String] The API version used during the recording.
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [String] The call during which the recording was made.
+            # @return [String] The SID of the Call the resource is associated with
             def call_sid
               @properties['call_sid']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [String] The unique ID for the conference associated with the recording.
+            def conference_sid
+              @properties['conference_sid']
+            end
+
+            ##
+            # @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] The length of the recording, in seconds.
+            # @return [Time] The start time of the recording, given in RFC 2822 format
+            def start_time
+              @properties['start_time']
+            end
+
+            ##
+            # @return [String] The length of the recording in seconds.
             def duration
               @properties['duration']
             end
 
             ##
-            # @return [String] A string that uniquely identifies this recording
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The price
+            # @return [String] The one-time cost of creating the recording.
             def price
               @properties['price']
             end
 
             ##
-            # @return [String] The price_unit
+            # @return [String] The currency used in the price property.
             def price_unit
               @properties['price_unit']
             end
 
             ##
-            # @return [transcription.Status] The status
+            # @return [recording.Status] The status of the recording.
             def status
               @properties['status']
             end
 
             ##
-            # @return [String] The channels
+            # @return [String] The number of channels in the final recording file as an integer.
             def channels
               @properties['channels']
             end
 
             ##
-            # @return [recording.Source] The source
+            # @return [recording.Source] How the recording was created
             def source
               @properties['source']
             end
 
             ##
-            # @return [String] The URI for this resource
+            # @return [String] More information about why the recording is missing, if status is `absent`.
+            def error_code
+              @properties['error_code']
+            end
+
+            ##
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
 
             ##
-            # @return [Hash] The encryption_details
+            # @return [Hash] How to decrypt the recording.
             def encryption_details
               @properties['encryption_details']
             end
 
             ##
-            # @return [String] More information about the recording failure, if Status is failed.
-            def error_code
-              @properties['error_code']
+            # @return [String] A list of related resources identified by their relative URIs
+            def subresource_uris
+              @properties['subresource_uris']
             end
 
             ##
-            # Fetch a RecordingInstance
+            # Fetch the RecordingInstance
             # @return [RecordingInstance] Fetched RecordingInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the RecordingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the RecordingInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end