twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class Intelligence < IntelligenceBase
             class V2 < Version
                 class TranscriptList < ListResource
+                
                     ##
                     # Initialize the TranscriptList
                     # @param [Version] version Version that contains the resource
                     # @return [TranscriptList] TranscriptList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Transcripts"
@@ -37,10 +39,10 @@ module Twilio
                     # @param [Time] media_start_time The date that this Transcript's media was started, given in ISO 8601 format.
                     # @return [TranscriptInstance] Created TranscriptInstance
                     def create(
-                        service_sid: nil, 
-                        channel: nil, 
-                        customer_key: :unset, 
-                        media_start_time: :unset
+                      service_sid: nil, 
+                      channel: nil, 
+                      customer_key: :unset, 
+                      media_start_time: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -50,13 +52,59 @@ module Twilio
                             'MediaStartTime' => Twilio.serialize_iso8601_datetime(media_start_time),
                         })
 
-                        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)
                         TranscriptInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the TranscriptInstanceMetadata
+                    # @param [String] service_sid The unique SID identifier of the Service.
+                    # @param [Object] channel JSON object describing Media Channel including Source and Participants
+                    # @param [String] customer_key Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters.
+                    # @param [Time] media_start_time The date that this Transcript's media was started, given in ISO 8601 format.
+                    # @return [TranscriptInstance] Created TranscriptInstance
+                    def create_with_metadata(
+                      service_sid: nil, 
+                      channel: nil, 
+                      customer_key: :unset, 
+                      media_start_time: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'ServiceSid' => service_sid,
+                            'Channel' => Twilio.serialize_object(channel),
+                            'CustomerKey' => customer_key,
+                            'MediaStartTime' => Twilio.serialize_iso8601_datetime(media_start_time),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        transcript_instance = TranscriptInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        TranscriptInstanceMetadata.new(
+                            @version,
+                            transcript_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists TranscriptInstance records from the API as a list.
@@ -125,7 +173,49 @@ module Twilio
                             source_sid: source_sid,
                             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 TranscriptPageMetadata records from the API as a list.
+                      # @param [String] service_sid The unique SID identifier of the Service.
+                      # @param [String] before_start_time Filter by before StartTime.
+                      # @param [String] after_start_time Filter by after StartTime.
+                      # @param [String] before_date_created Filter by before DateCreated.
+                      # @param [String] after_date_created Filter by after DateCreated.
+                      # @param [String] status Filter by status.
+                      # @param [String] language_code Filter by Language Code.
+                      # @param [String] source_sid Filter by SourceSid.
+                    # @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(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'ServiceSid' => service_sid,
+                            'BeforeStartTime' => before_start_time,
+                            'AfterStartTime' => after_start_time,
+                            'BeforeDateCreated' => before_date_created,
+                            'AfterDateCreated' => after_date_created,
+                            'Status' => status,
+                            'LanguageCode' => language_code,
+                            'SourceSid' => source_sid,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        TranscriptPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -137,9 +227,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
 
                     ##
@@ -157,7 +251,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 TranscriptInstance
-                    def page(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'ServiceSid' => service_sid,
                             'BeforeStartTime' => before_start_time,
@@ -171,8 +265,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)
 
                         TranscriptPage.new(@version, response, @solution)
                     end
@@ -199,8 +296,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class TranscriptContext < InstanceContext
                     ##
                     # Initialize the TranscriptContext
@@ -209,6 +304,7 @@ module Twilio
                     # @return [TranscriptContext] TranscriptContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -216,15 +312,41 @@ module Twilio
 
                         # Dependents
                         @sentences = nil
-                        @operator_results = nil
+                        @encrypted_sentences = nil
                         @media = nil
+                        @encrypted_operator_results = nil
+                        @operator_results = nil
                     end
                     ##
                     # Delete the TranscriptInstance
                     # @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 TranscriptInstanceMetadata
+                    # @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)
+                          transcript_instance = TranscriptInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          TranscriptInstanceMetadata.new(@version, transcript_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -232,7 +354,13 @@ module Twilio
                     # @return [TranscriptInstance] Fetched TranscriptInstance
                     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)
                         TranscriptInstance.new(
                             @version,
                             payload,
@@ -240,6 +368,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TranscriptInstanceMetadata
+                    # @return [TranscriptInstance] Fetched TranscriptInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        transcript_instance = TranscriptInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        TranscriptInstanceMetadata.new(
+                            @version,
+                            transcript_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the sentences
                     # @return [SentenceList]
@@ -252,6 +405,36 @@ module Twilio
                       @sentences
                     end
                     ##
+                    # Access the encrypted_sentences
+                    # @return [EncryptedSentencesList]
+                    # @return [EncryptedSentencesContext]
+                    def encrypted_sentences
+                        EncryptedSentencesContext.new(
+                                @version,
+                                @solution[:sid]
+                                )
+                    end
+                    ##
+                    # Access the media
+                    # @return [MediaList]
+                    # @return [MediaContext]
+                    def media
+                        MediaContext.new(
+                                @version,
+                                @solution[:sid]
+                                )
+                    end
+                    ##
+                    # Access the encrypted_operator_results
+                    # @return [EncryptedOperatorResultsList]
+                    # @return [EncryptedOperatorResultsContext]
+                    def encrypted_operator_results
+                        EncryptedOperatorResultsContext.new(
+                                @version,
+                                @solution[:sid]
+                                )
+                    end
+                    ##
                     # Access the operator_results
                     # @return [OperatorResultList]
                     # @return [OperatorResultContext] if sid was passed.
@@ -270,16 +453,6 @@ module Twilio
 
                      @operator_results
                     end
-                    ##
-                    # Access the media
-                    # @return [MediaList]
-                    # @return [MediaContext]
-                    def media
-                        MediaContext.new(
-                                @version,
-                                @solution[:sid]
-                                )
-                    end
 
                     ##
                     # Provide a user friendly representation
@@ -296,6 +469,53 @@ module Twilio
                     end
                 end
 
+                class TranscriptInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TranscriptInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TranscriptInstance] transcript_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 [TranscriptInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, transcript_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @transcript_instance = transcript_instance
+                    end
+
+                    def transcript
+                        @transcript_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TranscriptInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TranscriptListResponse < InstanceListResource
+                    # @param [Array<TranscriptInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @transcript_instance = payload.body[key].map do |data|
+                        TranscriptInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def transcript_instance
+                          @instance
+                      end
+                  end
+
                 class TranscriptPage < Page
                     ##
                     # Initialize the TranscriptPage
@@ -305,6 +525,7 @@ module Twilio
                     # @return [TranscriptPage] TranscriptPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -324,6 +545,66 @@ module Twilio
                         '<Twilio.Intelligence.V2.TranscriptPage>'
                     end
                 end
+
+                class TranscriptPageMetadata < PageMetadata
+                    attr_reader :transcript_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @transcript_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @transcript_page << TranscriptListResponse.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
+                        @transcript_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Intelligence::V2PageMetadata>';
+                    end
+                end
+                class TranscriptListResponse < InstanceListResource
+
+                    # @param [Array<TranscriptInstance>] 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
+                      @transcript = data_list.map do |data|
+                        TranscriptInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def transcript
+                        @transcript
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TranscriptInstance < InstanceResource
                     ##
                     # Initialize the TranscriptInstance
@@ -337,6 +618,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -353,6 +635,7 @@ module Twilio
                             'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
                             'url' => payload['url'],
                             'redaction' => payload['redaction'],
+                            'encryption_credential_sid' => payload['encryption_credential_sid'],
                             'links' => payload['links'],
                         }
 
@@ -415,7 +698,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Boolean] Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.
+                    # @return [Boolean] Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.
                     def data_logging
                         @properties['data_logging']
                     end
@@ -456,6 +739,12 @@ module Twilio
                         @properties['redaction']
                     end
                     
+                    ##
+                    # @return [String] The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.
+                    def encryption_credential_sid
+                        @properties['encryption_credential_sid']
+                    end
+                    
                     ##
                     # @return [Hash] 
                     def links
@@ -486,10 +775,10 @@ module Twilio
                     end
 
                     ##
-                    # Access the operator_results
-                    # @return [operator_results] operator_results
-                    def operator_results
-                        context.operator_results
+                    # Access the encrypted_sentences
+                    # @return [encrypted_sentences] encrypted_sentences
+                    def encrypted_sentences
+                        context.encrypted_sentences
                     end
 
                     ##
@@ -499,6 +788,20 @@ module Twilio
                         context.media
                     end
 
+                    ##
+                    # Access the encrypted_operator_results
+                    # @return [encrypted_operator_results] encrypted_operator_results
+                    def encrypted_operator_results
+                        context.encrypted_operator_results
+                    end
+
+                    ##
+                    # Access the operator_results
+                    # @return [operator_results] operator_results
+                    def operator_results
+                        context.operator_results
+                    end
+
                     ##
                     # Provide a user friendly representation
                     def to_s

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

@@ -21,10 +21,133 @@ module Twilio
                 def initialize(domain)
                     super
                     @version = 'v2'
+                    @custom_operators = nil
+                    @operators = nil
+                    @operator_attachment = nil
+                    @operator_attachments = nil
+                    @operator_type = nil
+                    @prebuilt_operators = nil
                     @services = nil
                     @transcripts = nil
                 end
 
+                ##
+                # @param [String] sid A 34 character string that uniquely identifies this Custom Operator.
+                # @return [Twilio::REST::Intelligence::V2::CustomOperatorContext] if sid was passed.
+                # @return [Twilio::REST::Intelligence::V2::CustomOperatorList]
+                def custom_operators(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @custom_operators ||= CustomOperatorList.new self
+                    else
+                        CustomOperatorContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid A 34 character string that uniquely identifies this Operator.
+                # @return [Twilio::REST::Intelligence::V2::OperatorContext] if sid was passed.
+                # @return [Twilio::REST::Intelligence::V2::OperatorList]
+                def operators(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @operators ||= OperatorList.new self
+                    else
+                        OperatorContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] service_sid The unique SID identifier of the Service.
+                # @param [String] operator_sid The unique SID identifier of the Operator. Allows both Custom and Pre-built Operators.
+                # @return [Twilio::REST::Intelligence::V2::OperatorAttachmentContext] if serviceSid was passed.
+                # @return [Twilio::REST::Intelligence::V2::OperatorAttachmentList]
+                def operator_attachment(service_sid=:unset, operator_sid=:unset)
+                    if service_sid.nil?
+                        raise ArgumentError, 'service_sid cannot be nil'
+                    end
+                    if operator_sid.nil?
+                        raise ArgumentError, 'operator_sid cannot be nil'
+                    end
+
+                    if service_sid == :unset && operator_sid == :unset
+                        @operator_attachment ||= OperatorAttachmentList.new self
+                    elsif service_sid != :unset && operator_sid == :unset
+                        OperatorAttachmentList.new(self, service_sid: service_sid)
+                    else
+                        OperatorAttachmentContext.new(self, service_sid, operator_sid)
+                    end
+                end
+                ##
+                # @param [String] service_sid The unique SID identifier of the Service.
+                # @param [String] operator_sid The unique SID identifier of the Operator. Allows both Custom and Pre-built Operators.
+                # @return [Twilio::REST::Intelligence::V2::OperatorAttachmentContext] if operatorSid was passed.
+                # @return [Twilio::REST::Intelligence::V2::OperatorAttachmentList]
+                def operator_attachment(service_sid=:unset, operator_sid=:unset)
+                    if service_sid.nil?
+                        raise ArgumentError, 'service_sid cannot be nil'
+                    end
+                    if operator_sid.nil?
+                        raise ArgumentError, 'operator_sid cannot be nil'
+                    end
+
+                    if service_sid == :unset && operator_sid == :unset
+                        @operator_attachment ||= OperatorAttachmentList.new self
+                    elsif service_sid != :unset && operator_sid == :unset
+                        OperatorAttachmentList.new(self, service_sid: service_sid)
+                    else
+                        OperatorAttachmentContext.new(self, service_sid, operator_sid)
+                    end
+                end
+                ##
+                # @param [String] service_sid The unique SID identifier of the Service.
+                # @return [Twilio::REST::Intelligence::V2::OperatorAttachmentsContext] if serviceSid was passed.
+                # @return [Twilio::REST::Intelligence::V2::OperatorAttachmentsList]
+                def operator_attachments(service_sid=:unset)
+                    if service_sid.nil?
+                        raise ArgumentError, 'service_sid cannot be nil'
+                    end
+
+                    if service_sid == :unset
+                        @operator_attachments ||= OperatorAttachmentsList.new self
+                    else
+                        OperatorAttachmentsContext.new(self, service_sid)
+                    end
+                end
+                ##
+                # @param [String] sid Either a 34 character string that uniquely identifies this Operator Type or the unique name that references an Operator Type.
+                # @return [Twilio::REST::Intelligence::V2::OperatorTypeContext] if sid was passed.
+                # @return [Twilio::REST::Intelligence::V2::OperatorTypeList]
+                def operator_type(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @operator_type ||= OperatorTypeList.new self
+                    else
+                        OperatorTypeContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid A 34 character string that uniquely identifies this Pre-built Operator.
+                # @return [Twilio::REST::Intelligence::V2::PrebuiltOperatorContext] if sid was passed.
+                # @return [Twilio::REST::Intelligence::V2::PrebuiltOperatorList]
+                def prebuilt_operators(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @prebuilt_operators ||= PrebuiltOperatorList.new self
+                    else
+                        PrebuiltOperatorContext.new(self, sid)
+                    end
+                end
                 ##
                 # @param [String] sid A 34 character string that uniquely identifies this Service.
                 # @return [Twilio::REST::Intelligence::V2::ServiceContext] if sid was passed.
@@ -33,6 +156,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @services ||= ServiceList.new self
                     else
@@ -47,6 +171,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @transcripts ||= TranscriptList.new self
                     else