twilio-ruby 6.8.0 → 7.10.7

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

@@ -21,12 +21,14 @@ module Twilio
                 class CallContext < InstanceContext
 
                      class RecordingList < ListResource
+                
                     ##
                     # Initialize the RecordingList
                     # @param [Version] version Version that contains the resource
                     # @return [RecordingList] RecordingList
                     def initialize(version, account_sid: nil, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid, call_sid: call_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings.json"
@@ -40,14 +42,16 @@ module Twilio
                     # @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.
                     # @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.
+                    # @param [String] recording_configuration_id The identifier of the configuration to be used when creating and processing the recording
                     # @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
+                      recording_status_callback_event: :unset, 
+                      recording_status_callback: :unset, 
+                      recording_status_callback_method: :unset, 
+                      trim: :unset, 
+                      recording_channels: :unset, 
+                      recording_track: :unset, 
+                      recording_configuration_id: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -57,9 +61,16 @@ module Twilio
                             'Trim' => trim,
                             'RecordingChannels' => recording_channels,
                             'RecordingTrack' => recording_track,
+                            'RecordingConfigurationId' => recording_configuration_id,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         RecordingInstance.new(
                             @version,
                             payload,
@@ -68,6 +79,57 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the RecordingInstanceMetadata
+                    # @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).
+                    # @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.
+                    # @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.
+                    # @param [String] recording_configuration_id The identifier of the configuration to be used when creating and processing the recording
+                    # @return [RecordingInstance] Created RecordingInstance
+                    def create_with_metadata(
+                      recording_status_callback_event: :unset, 
+                      recording_status_callback: :unset, 
+                      recording_status_callback_method: :unset, 
+                      trim: :unset, 
+                      recording_channels: :unset, 
+                      recording_track: :unset, 
+                      recording_configuration_id: :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,
+                            'RecordingConfigurationId' => recording_configuration_id,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        recording_instance = RecordingInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                        )
+                        RecordingInstanceMetadata.new(
+                            @version,
+                            recording_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists RecordingInstance records from the API as a list.
@@ -116,7 +178,39 @@ module Twilio
                             date_created_after: date_created_after,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists RecordingPageMetadata records from the API as a list.
+                      # @param [Date] date_created The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.
+                      # @param [Date] date_created_before The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.
+                      # @param [Date] date_created_after The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.
+                    # @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)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(date_created: :unset, date_created_before: :unset, date_created_after: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'DateCreated' =>  Twilio.serialize_iso8601_date(date_created),
+                            'DateCreated<' =>  Twilio.serialize_iso8601_date(date_created_before),
+                            'DateCreated>' =>  Twilio.serialize_iso8601_date(date_created_after),
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RecordingPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -128,9 +222,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -143,7 +241,7 @@ module Twilio
                     # @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: :unset, date_created_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'DateCreated' =>  Twilio.serialize_iso8601_date(date_created),
                             'DateCreated<' =>  Twilio.serialize_iso8601_date(date_created_before),
@@ -152,8 +250,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         RecordingPage.new(@version, response, @solution)
                     end
@@ -190,6 +291,7 @@ module Twilio
                     # @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,  }
@@ -202,7 +304,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the RecordingInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          recording_instance = RecordingInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          RecordingInstanceMetadata.new(@version, recording_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -210,7 +336,13 @@ module Twilio
                     # @return [RecordingInstance] Fetched RecordingInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         RecordingInstance.new(
                             @version,
                             payload,
@@ -220,14 +352,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RecordingInstanceMetadata
+                    # @return [RecordingInstance] Fetched RecordingInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        recording_instance = RecordingInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                            sid: @solution[:sid],
+                        )
+                        RecordingInstanceMetadata.new(
+                            @version,
+                            recording_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the RecordingInstance
                     # @param [Status] status 
                     # @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
+                      status: nil, 
+                      pause_behavior: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -235,7 +394,13 @@ module Twilio
                             'PauseBehavior' => pause_behavior,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         RecordingInstance.new(
                             @version,
                             payload,
@@ -245,6 +410,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the RecordingInstanceMetadata
+                    # @param [Status] status 
+                    # @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_with_metadata(
+                      status: nil, 
+                      pause_behavior: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                            'PauseBehavior' => pause_behavior,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        recording_instance = RecordingInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            call_sid: @solution[:call_sid],
+                            sid: @solution[:sid],
+                        )
+                        RecordingInstanceMetadata.new(
+                            @version,
+                            recording_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -261,6 +463,53 @@ module Twilio
                     end
                 end
 
+                class RecordingInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new RecordingInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}RecordingInstance] recording_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [RecordingInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, recording_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @recording_instance = recording_instance
+                    end
+
+                    def recording
+                        @recording_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.RecordingInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class RecordingListResponse < InstanceListResource
+                    # @param [Array<RecordingInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @recording_instance = payload.body[key].map do |data|
+                        RecordingInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def recording_instance
+                          @instance
+                      end
+                  end
+
                 class RecordingPage < Page
                     ##
                     # Initialize the RecordingPage
@@ -270,6 +519,7 @@ module Twilio
                     # @return [RecordingPage] RecordingPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -289,6 +539,66 @@ module Twilio
                         '<Twilio.Api.V2010.RecordingPage>'
                     end
                 end
+
+                class RecordingPageMetadata < PageMetadata
+                    attr_reader :recording_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @recording_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @recording_page << RecordingListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @recording_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class RecordingListResponse < InstanceListResource
+
+                    # @param [Array<RecordingInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @recording = data_list.map do |data|
+                        RecordingInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def recording
+                        @recording
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class RecordingInstance < InstanceResource
                     ##
                     # Initialize the RecordingInstance
@@ -302,6 +612,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, call_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -470,8 +781,8 @@ module Twilio
                     # @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
+                      status: nil, 
+                      pause_behavior: :unset
                     )
 
                         context.update(