twilio-ruby 5.19.0 → 5.74.2

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,11 +17,11 @@ module Twilio
               # Initialize the RecordingList
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The SID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
               #   Recording resource.
               # @param [String] call_sid The SID of the
-              #   [Call](https://www.twilio.com/docs/api/voice/call) this Recording resource is
-              #   associated with.
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Recording
+              #   resource is associated with.
               # @return [RecordingList] RecordingList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -32,20 +32,19 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of RecordingInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] recording_status_callback_event The recording status events on
-              #   which we should call the `recording_status_callback` URL. Can be: `in-progress`,
-              #   `completed` and `absent` and the default is `completed`. Separate multiple event
-              #   values with a space. 
-              # @param [String] recording_status_callback The URL we call using the
-              #   `recording_status_callback_method` on each recording event specified in 
+              # Create the RecordingInstance
+              # @param [Array[String]] recording_status_callback_event The recording status
+              #   events on which we should call the `recording_status_callback` URL. Can be:
+              #   `in-progress`, `completed` and `absent` and the default is `completed`. Separate
+              #   multiple event values with a space.
+              # @param [String] recording_status_callback The URL we should call using the
+              #   `recording_status_callback_method` on each recording event specified in
               #   `recording_status_callback_event`. For more information, see
-              #   [RecordingStatusCallback
-              #   parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback).
+              #   {RecordingStatusCallback
+              #   parameters}[https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback].
               # @param [String] recording_status_callback_method The HTTP method we should use
-              #   when calling the `recording_status_callback` URL. Can be: `GET`, `POST` and the
-              #   default is `POST`.
+              #   to call `recording_status_callback`. Can be: `GET` or `POST` and the default is
+              #   `POST`.
               # @param [String] trim Whether to trim any leading and trailing silence in the
               #   recording. Can be: `trim-silence` or `do-not-trim` and the default is
               #   `do-not-trim`. `trim-silence` trims the silence from the beginning and end of
@@ -54,21 +53,22 @@ module Twilio
               #   Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties
               #   of the call into one channel. `dual` records each party of a 2-party call into
               #   separate channels.
-              # @return [RecordingInstance] Newly created RecordingInstance
-              def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset)
+              # @param [String] recording_track The audio track to record for the call. Can be:
+              #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
+              #   audio that is received by Twilio. `outbound` records the audio that is generated
+              #   from Twilio. `both` records the audio that is received and generated by Twilio.
+              # @return [RecordingInstance] Created RecordingInstance
+              def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset, recording_track: :unset)
                 data = Twilio::Values.of({
                     'RecordingStatusCallbackEvent' => Twilio.serialize_list(recording_status_callback_event) { |e| e },
                     'RecordingStatusCallback' => recording_status_callback,
                     'RecordingStatusCallbackMethod' => recording_status_callback_method,
                     'Trim' => trim,
                     'RecordingChannels' => recording_channels,
+                    'RecordingTrack' => recording_track,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 RecordingInstance.new(
                     @version,
@@ -162,11 +162,9 @@ module Twilio
                     '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
 
@@ -229,12 +227,13 @@ module Twilio
               # Initialize the RecordingContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The SID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
-              #   Recording resource(s) to fetch.
-              # @param [String] call_sid The [Call](https://www.twilio.com/docs/api/voice/call)
-              #   SID of the resource(s) to fetch.
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   Recording resource to fetch.
+              # @param [String] call_sid The
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] SID of the resource
+              #   to fetch.
               # @param [String] sid The Twilio-provided string that uniquely identifies the
-              #   Recording resource to fetch
+              #   Recording resource to fetch.
               # @return [RecordingContext] RecordingContext
               def initialize(version, account_sid, call_sid, sid)
                 super(version)
@@ -247,7 +246,7 @@ module Twilio
               ##
               # Update the RecordingInstance
               # @param [recording.Status] status The new status of the recording. Can be:
-              #   `stopped`, `paused`, `in-progress`
+              #   `stopped`, `paused`, `in-progress`.
               # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
               #   or `silence` and the default is `silence`. `skip` does not record during the
               #   pause period, while `silence` will replace the actual audio of the call with
@@ -257,11 +256,7 @@ module Twilio
               def update(status: nil, pause_behavior: :unset)
                 data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 RecordingInstance.new(
                     @version,
@@ -273,16 +268,10 @@ module Twilio
               end
 
               ##
-              # Fetch a RecordingInstance
+              # Fetch the RecordingInstance
               # @return [RecordingInstance] Fetched RecordingInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 RecordingInstance.new(
                     @version,
@@ -294,10 +283,10 @@ module Twilio
               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
 
               ##
@@ -306,6 +295,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
@@ -314,13 +310,13 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid The SID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
               #   Recording resource.
               # @param [String] call_sid The SID of the
-              #   [Call](https://www.twilio.com/docs/api/voice/call) this Recording resource is
-              #   associated with.
+              #   {Call}[https://www.twilio.com/docs/voice/api/call-resource] the Recording
+              #   resource is associated with.
               # @param [String] sid The Twilio-provided string that uniquely identifies the
-              #   Recording resource to fetch
+              #   Recording resource to fetch.
               # @return [RecordingInstance] RecordingInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil)
                 super(version)
@@ -336,14 +332,15 @@ module Twilio
                     'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
                     'duration' => payload['duration'],
                     'sid' => payload['sid'],
-                    'price' => payload['price'].to_f,
+                    'price' => payload['price'] == nil ? payload['price'] : payload['price'].to_f,
                     'uri' => payload['uri'],
                     'encryption_details' => payload['encryption_details'],
                     'price_unit' => payload['price_unit'],
                     'status' => payload['status'],
-                    'channels' => payload['channels'].to_i,
+                    'channels' => payload['channels'] == nil ? payload['channels'] : payload['channels'].to_i,
                     'source' => payload['source'],
                     'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                    'track' => payload['track'],
                 }
 
                 # Context
@@ -368,7 +365,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The SID of the Account that created this resource
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
@@ -380,7 +377,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The SID of the Call this resource is associated with
+              # @return [String] The SID of the Call the resource is associated with
               def call_sid
                 @properties['call_sid']
               end
@@ -392,13 +389,13 @@ module Twilio
               end
 
               ##
-              # @return [Time] The RFC 2822 date and time in GMT that 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 RFC 2822 date and time in GMT that 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
@@ -416,63 +413,69 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique string that identifies this resource
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The one-time cost of creating this recording.
+              # @return [String] The one-time cost of creating the recording.
               def price
                 @properties['price']
               end
 
               ##
-              # @return [String] The URI of this resource, relative to `https://api.twilio.com`
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
-              # @return [Hash] Details about how to decrypt the recording
+              # @return [Hash] How to decrypt the recording.
               def encryption_details
                 @properties['encryption_details']
               end
 
               ##
-              # @return [String] The currency used in the Price property
+              # @return [String] The currency used in the price property.
               def price_unit
                 @properties['price_unit']
               end
 
               ##
-              # @return [recording.Status] The status of this recording
+              # @return [recording.Status] The status of the recording
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The number of channels in the final recording file as an integer
+              # @return [String] The number of channels in the final recording file
               def channels
                 @properties['channels']
               end
 
               ##
-              # @return [recording.Source] How this recording was created
+              # @return [recording.Source] How the recording was created
               def source
                 @properties['source']
               end
 
               ##
-              # @return [String] More information about why the recording is missing, if status is `absent`
+              # @return [String] More information about why the recording is missing, if status is `absent`.
               def error_code
                 @properties['error_code']
               end
 
+              ##
+              # @return [String] The recorded track. Can be: `inbound`, `outbound`, or `both`.
+              def track
+                @properties['track']
+              end
+
               ##
               # Update the RecordingInstance
               # @param [recording.Status] status The new status of the recording. Can be:
-              #   `stopped`, `paused`, `in-progress`
+              #   `stopped`, `paused`, `in-progress`.
               # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
               #   or `silence` and the default is `silence`. `skip` does not record during the
               #   pause period, while `silence` will replace the actual audio of the call with
@@ -484,15 +487,15 @@ module Twilio
               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