twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb

@@ -20,12 +20,14 @@ module Twilio
                 class TranscriptContext < InstanceContext
 
                      class OperatorResultList < ListResource
+                
                     ##
                     # Initialize the OperatorResultList
                     # @param [Version] version Version that contains the resource
                     # @return [OperatorResultList] OperatorResultList
                     def initialize(version, transcript_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { transcript_sid: transcript_sid }
                         @uri = "/Transcripts/#{@solution[:transcript_sid]}/OperatorResults"
@@ -71,7 +73,35 @@ module Twilio
                             redacted: redacted,
                             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 OperatorResultPageMetadata records from the API as a list.
+                      # @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
+                    # @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(redacted: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Redacted' => redacted,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        OperatorResultPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -83,9 +113,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
 
                     ##
@@ -96,15 +130,18 @@ 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 OperatorResultInstance
-                    def page(redacted: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(redacted: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Redacted' => redacted,
                             'PageToken' => page_token,
                             '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)
 
                         OperatorResultPage.new(@version, response, @solution)
                     end
@@ -131,8 +168,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class OperatorResultContext < InstanceContext
                     ##
                     # Initialize the OperatorResultContext
@@ -142,6 +177,7 @@ module Twilio
                     # @return [OperatorResultContext] OperatorResultContext
                     def initialize(version, transcript_sid, operator_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { transcript_sid: transcript_sid, operator_sid: operator_sid,  }
@@ -154,13 +190,19 @@ module Twilio
                     # @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
                     # @return [OperatorResultInstance] Fetched OperatorResultInstance
                     def fetch(
-                        redacted: :unset
+                      redacted: :unset
                     )
 
                         params = Twilio::Values.of({
                             'Redacted' => redacted,
                         })
-                        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)
                         OperatorResultInstance.new(
                             @version,
                             payload,
@@ -169,6 +211,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the OperatorResultInstanceMetadata
+                    # @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
+                    # @return [OperatorResultInstance] Fetched OperatorResultInstance
+                    def fetch_with_metadata(
+                      redacted: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Redacted' => redacted,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        operator_result_instance = OperatorResultInstance.new(
+                            @version,
+                            response.body,
+                            transcript_sid: @solution[:transcript_sid],
+                            operator_sid: @solution[:operator_sid],
+                        )
+                        OperatorResultInstanceMetadata.new(
+                            @version,
+                            operator_result_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -185,6 +259,53 @@ module Twilio
                     end
                 end
 
+                class OperatorResultInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new OperatorResultInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}OperatorResultInstance] operator_result_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 [OperatorResultInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, operator_result_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @operator_result_instance = operator_result_instance
+                    end
+
+                    def operator_result
+                        @operator_result_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.OperatorResultInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class OperatorResultListResponse < InstanceListResource
+                    # @param [Array<OperatorResultInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @operator_result_instance = payload.body[key].map do |data|
+                        OperatorResultInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def operator_result_instance
+                          @instance
+                      end
+                  end
+
                 class OperatorResultPage < Page
                     ##
                     # Initialize the OperatorResultPage
@@ -194,6 +315,7 @@ module Twilio
                     # @return [OperatorResultPage] OperatorResultPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -213,6 +335,66 @@ module Twilio
                         '<Twilio.Intelligence.V2.OperatorResultPage>'
                     end
                 end
+
+                class OperatorResultPageMetadata < PageMetadata
+                    attr_reader :operator_result_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @operator_result_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @operator_result_page << OperatorResultListResponse.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
+                        @operator_result_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Intelligence::V2PageMetadata>';
+                    end
+                end
+                class OperatorResultListResponse < InstanceListResource
+
+                    # @param [Array<OperatorResultInstance>] 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
+                      @operator_result = data_list.map do |data|
+                        OperatorResultInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def operator_result
+                        @operator_result
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class OperatorResultInstance < InstanceResource
                     ##
                     # Initialize the OperatorResultInstance
@@ -226,6 +408,7 @@ module Twilio
                     def initialize(version, payload , transcript_sid: nil, operator_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'operator_type' => payload['operator_type'],
@@ -240,6 +423,8 @@ module Twilio
                             'predicted_probability' => payload['predicted_probability'],
                             'label_probabilities' => payload['label_probabilities'],
                             'extract_results' => payload['extract_results'],
+                            'text_generation_results' => payload['text_generation_results'],
+                            'json_results' => payload['json_results'],
                             'transcript_sid' => payload['transcript_sid'],
                             'url' => payload['url'],
                         }
@@ -332,6 +517,18 @@ module Twilio
                         @properties['extract_results']
                     end
                     
+                    ##
+                    # @return [Hash] Output of a text generation operator for example Conversation Sumamary.
+                    def text_generation_results
+                        @properties['text_generation_results']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def json_results
+                        @properties['json_results']
+                    end
+                    
                     ##
                     # @return [String] A 34 character string that uniquely identifies this Transcript.
                     def transcript_sid
@@ -349,7 +546,7 @@ module Twilio
                     # @param [Boolean] redacted Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.
                     # @return [OperatorResultInstance] Fetched OperatorResultInstance
                     def fetch(
-                        redacted: :unset
+                      redacted: :unset
                     )
 
                         context.fetch(

data/lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb

@@ -20,12 +20,14 @@ module Twilio
                 class TranscriptContext < InstanceContext
 
                      class SentenceList < ListResource
+                
                     ##
                     # Initialize the SentenceList
                     # @param [Version] version Version that contains the resource
                     # @return [SentenceList] SentenceList
                     def initialize(version, transcript_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { transcript_sid: transcript_sid }
                         @uri = "/Transcripts/#{@solution[:transcript_sid]}/Sentences"
@@ -37,6 +39,7 @@ module Twilio
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
                     # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
+                    # @param [Boolean] word_timestamps Returns word level timestamps information, if word_timestamps is enabled. The default is `false`.
                     # @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
@@ -44,9 +47,10 @@ 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(redacted: :unset, limit: nil, page_size: nil)
+                    def list(redacted: :unset, word_timestamps: :unset, limit: nil, page_size: nil)
                         self.stream(
                             redacted: redacted,
+                            word_timestamps: word_timestamps,
                             limit: limit,
                             page_size: page_size
                         ).entries
@@ -57,6 +61,7 @@ module Twilio
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
                     # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
+                    # @param [Boolean] word_timestamps Returns word level timestamps information, if word_timestamps is enabled. The default is `false`.
                     # @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
@@ -64,14 +69,45 @@ 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(redacted: :unset, limit: nil, page_size: nil)
+                    def stream(redacted: :unset, word_timestamps: :unset, limit: nil, page_size: nil)
                         limits = @version.read_limits(limit, page_size)
 
                         page = self.page(
                             redacted: redacted,
+                            word_timestamps: word_timestamps,
                             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 SentencePageMetadata records from the API as a list.
+                      # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
+                      # @param [Boolean] word_timestamps Returns word level timestamps information, if word_timestamps is enabled. The default is `false`.
+                    # @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(redacted: :unset, word_timestamps: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Redacted' => redacted,
+                            'WordTimestamps' => word_timestamps,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SentencePageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -83,28 +119,37 @@ 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
 
                     ##
                     # Retrieve a single page of SentenceInstance records from the API.
                     # Request is executed immediately.
                     # @param [Boolean] redacted Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.
+                    # @param [Boolean] word_timestamps Returns word level timestamps information, if word_timestamps is enabled. The default is `false`.
                     # @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 SentenceInstance
-                    def page(redacted: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(redacted: :unset, word_timestamps: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Redacted' => redacted,
+                            'WordTimestamps' => word_timestamps,
                             'PageToken' => page_token,
                             '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)
 
                         SentencePage.new(@version, response, @solution)
                     end
@@ -139,6 +184,7 @@ module Twilio
                     # @return [SentencePage] SentencePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -158,6 +204,66 @@ module Twilio
                         '<Twilio.Intelligence.V2.SentencePage>'
                     end
                 end
+
+                class SentencePageMetadata < PageMetadata
+                    attr_reader :sentence_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @sentence_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @sentence_page << SentenceListResponse.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
+                        @sentence_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Intelligence::V2PageMetadata>';
+                    end
+                end
+                class SentenceListResponse < InstanceListResource
+
+                    # @param [Array<SentenceInstance>] 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
+                      @sentence = data_list.map do |data|
+                        SentenceInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def sentence
+                        @sentence
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SentenceInstance < InstanceResource
                     ##
                     # Initialize the SentenceInstance
@@ -171,6 +277,7 @@ module Twilio
                     def initialize(version, payload , transcript_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'media_channel' => payload['media_channel'] == nil ? payload['media_channel'] : payload['media_channel'].to_i,
@@ -180,6 +287,7 @@ module Twilio
                             'transcript' => payload['transcript'],
                             'sid' => payload['sid'],
                             'confidence' => payload['confidence'],
+                            'words' => payload['words'],
                         }
                     end
 
@@ -197,13 +305,13 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Float] Offset from the beginning of the transcript when this sentence starts.
+                    # @return [String] Offset from the beginning of the transcript when this sentence starts.
                     def start_time
                         @properties['start_time']
                     end
                     
                     ##
-                    # @return [Float] Offset from the beginning of the transcript when this sentence ends.
+                    # @return [String] Offset from the beginning of the transcript when this sentence ends.
                     def end_time
                         @properties['end_time']
                     end
@@ -221,11 +329,17 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Float] 
+                    # @return [String] 
                     def confidence
                         @properties['confidence']
                     end
                     
+                    ##
+                    # @return [Array<Hash>] Detailed information for each of the words of the given Sentence.
+                    def words
+                        @properties['words']
+                    end
+                    
                     ##
                     # Provide a user friendly representation
                     def to_s