twilio-ruby 6.8.0 → 7.10.7

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

@@ -20,12 +20,14 @@ module Twilio
                 class AccountContext < InstanceContext
 
                      class RecordingList < ListResource
+                
                     ##
                     # Initialize the RecordingList
                     # @param [Version] version Version that contains the resource
                     # @return [RecordingList] RecordingList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Recordings.json"
@@ -91,7 +93,45 @@ module Twilio
                             include_soft_deleted: include_soft_deleted,
                             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 [Time] date_created Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.
+                      # @param [Time] date_created_before Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.
+                      # @param [Time] date_created_after Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of 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 [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.
+                    # @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, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'DateCreated' =>  Twilio.serialize_iso8601_datetime(date_created),
+                            'DateCreated<' =>  Twilio.serialize_iso8601_datetime(date_created_before),
+                            'DateCreated>' =>  Twilio.serialize_iso8601_datetime(date_created_after),
+                            'CallSid' => call_sid,
+                            'ConferenceSid' => conference_sid,
+                            'IncludeSoftDeleted' => include_soft_deleted,
+                            
+                            '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
 
                     ##
@@ -103,9 +143,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
 
                     ##
@@ -121,7 +165,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, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(date_created: :unset, date_created_before: :unset, date_created_after: :unset, call_sid: :unset, conference_sid: :unset, include_soft_deleted: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'DateCreated' =>  Twilio.serialize_iso8601_datetime(date_created),
                             'DateCreated<' =>  Twilio.serialize_iso8601_datetime(date_created_before),
@@ -133,8 +177,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
@@ -170,6 +217,7 @@ module Twilio
                     # @return [RecordingContext] RecordingContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -184,7 +232,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
 
                     ##
@@ -192,13 +264,19 @@ module Twilio
                     # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.
                     # @return [RecordingInstance] Fetched RecordingInstance
                     def fetch(
-                        include_soft_deleted: :unset
+                      include_soft_deleted: :unset
                     )
 
                         params = Twilio::Values.of({
                             'IncludeSoftDeleted' => include_soft_deleted,
                         })
-                        payload = @version.fetch('GET', @uri, params: params)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         RecordingInstance.new(
                             @version,
                             payload,
@@ -207,6 +285,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the RecordingInstanceMetadata
+                    # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.
+                    # @return [RecordingInstance] Fetched RecordingInstance
+                    def fetch_with_metadata(
+                      include_soft_deleted: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'IncludeSoftDeleted' => include_soft_deleted,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, 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
+
                     ##
                     # Access the add_on_results
                     # @return [AddOnResultList]
@@ -261,6 +371,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 +427,7 @@ module Twilio
                     # @return [RecordingPage] RecordingPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -289,6 +447,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 +520,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -414,7 +633,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The number of channels in the final recording file. Can be: `1` or `2`. You can split a call with two legs into two separate recording channels if you record using [TwiML Dial](https://www.twilio.com/docs/voice/twiml/dial#record) or the [Outbound Rest API](https://www.twilio.com/docs/voice/make-calls#manage-your-outbound-call).
+                    # @return [String] The number of channels in the recording resource. For information on specifying the number of channels in the downloaded recording file, check out [Fetch a Recording’s media file](https://www.twilio.com/docs/voice/api/recording#download-dual-channel-media-file).
                     def channels
                         @properties['channels']
                     end
@@ -468,7 +687,7 @@ module Twilio
                     # @param [Boolean] include_soft_deleted A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.
                     # @return [RecordingInstance] Fetched RecordingInstance
                     def fetch(
-                        include_soft_deleted: :unset
+                      include_soft_deleted: :unset
                     )
 
                         context.fetch(