twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,12 @@ module Twilio
               ##
               # Initialize the RecordingList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] call_sid The call_sid
+              # @param [String] account_sid The SID of the
+              #   [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/voice/api/call-resource) the Recording
+              #   resource is associated with.
               # @return [RecordingList] RecordingList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -25,13 +31,60 @@ module Twilio
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings.json"
               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 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).
+              # @param [String] recording_status_callback_method The HTTP method we should use
+              #   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
+              #   the recording and `do-not-trim` does not.
+              # @param [String] recording_channels The number of channels used in the recording.
+              #   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)
+                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,
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
               ##
               # 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 The date_created
-              # @param [Time] date_created The date_created
-              # @param [Time] date_created_after The date_created
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources 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
@@ -53,9 +106,9 @@ 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 The date_created
-              # @param [Time] date_created The date_created
-              # @param [Time] date_created_after The date_created
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources 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
@@ -83,7 +136,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],
@@ -93,9 +146,9 @@ module Twilio
               ##
               # Retrieve a single page of RecordingInstance records from the API.
               # Request is executed immediately.
-              # @param [Time] date_created_before The date_created
-              # @param [Time] date_created The date_created
-              # @param [Time] date_created_after The date_created
+              # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+              # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources 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
@@ -175,18 +228,51 @@ module Twilio
               ##
               # Initialize the RecordingContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] call_sid The call_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
+              #   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.
               # @return [RecordingContext] RecordingContext
               def initialize(version, account_sid, call_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, call_sid: call_sid, sid: sid}
+                @solution = {account_sid: account_sid, call_sid: call_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings/#{@solution[:sid]}.json"
               end
 
+              ##
+              # Update the RecordingInstance
+              # @param [recording.Status] status The new status of the recording. Can be:
+              #   `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
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
+              # @return [RecordingInstance] Updated RecordingInstance
+              def update(status: nil, pause_behavior: :unset)
+                data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
               ##
               # Fetch a RecordingInstance
               # @return [RecordingInstance] Fetched RecordingInstance
@@ -210,7 +296,7 @@ module Twilio
 
               ##
               # Deletes the RecordingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -221,6 +307,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
@@ -228,9 +321,14 @@ 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 account_sid
-              # @param [String] call_sid The call_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
+              #   Recording resource.
+              # @param [String] call_sid The SID of the
+              #   [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.
               # @return [RecordingInstance] RecordingInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil)
                 super(version)
@@ -240,8 +338,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'].to_f,
@@ -256,7 +356,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'call_sid' => call_sid, 'sid' => sid || @properties['sid']}
+                @params = {'account_sid' => account_sid, 'call_sid' => call_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -276,95 +376,121 @@ 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 make the recording
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [String] The call_sid
+              # @return [String] The SID of the Call the resource is associated with
               def call_sid
                 @properties['call_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [String] The Conference SID that identifies 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_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 [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] The sid
+              # @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 uri
+              # @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] The price_unit
+              # @return [String] The currency used in the price property.
               def price_unit
                 @properties['price_unit']
               end
 
               ##
-              # @return [recording.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
               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 error_code
+              # @return [String] More information about why the recording is missing, if status is `absent`.
               def error_code
                 @properties['error_code']
               end
 
+              ##
+              # Update the RecordingInstance
+              # @param [recording.Status] status The new status of the recording. Can be:
+              #   `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
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
+              # @return [RecordingInstance] Updated RecordingInstance
+              def update(status: nil, pause_behavior: :unset)
+                context.update(status: status, pause_behavior: pause_behavior, )
+              end
+
               ##
               # Fetch a RecordingInstance
               # @return [RecordingInstance] Fetched RecordingInstance
@@ -374,7 +500,7 @@ module Twilio
 
               ##
               # Deletes the RecordingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end