twilio-ruby 7.10.5 → 7.10.6

data/lib/twilio-ruby/rest/intelligence/v3/operator_result.rb

@@ -0,0 +1,622 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Conversational Intelligence API
+#    The Conversational Intelligence API includes resources to create and manage intelligence configurations, define and run language operators, and retrieve processed conversations and operator results.  * Use the Configurations resource to create and manage intelligence configurations and define rules that control how and when language operators analyze and transform conversations.  * Use the Operators resource to create custom language operators or retrieve Twilio-author and custom operators. * Use the Conversations resource to retrieve conversations processed with an intelligence configuration, and the OperatorResults resource to retrieve language operator results for those conversations. 
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Intelligence < IntelligenceBase
+            class V3 < Version
+                class OperatorResultList < ListResource
+                
+                    ##
+                    # Initialize the OperatorResultList
+                    # @param [Version] version Version that contains the resource
+                    # @return [OperatorResultList] OperatorResultList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/OperatorResults"
+                        
+                    end
+                
+                    ##
+                    # Lists OperatorResultInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] conversation_id Filter Operator Results by attached Conversation `id`.
+                    # @param [String] intelligence_configuration_id Filter Operator Results by Intelligence Configuration `id` used to generate them.
+                    # @param [String] operator_id Filter Operator Results by Language Operator `id`.
+                    # @param [String] page_token Token for pagination
+                    # @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(conversation_id: :unset, intelligence_configuration_id: :unset, operator_id: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            conversation_id: conversation_id,
+                            intelligence_configuration_id: intelligence_configuration_id,
+                            operator_id: operator_id,
+                            page_token: page_token,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [String] conversation_id Filter Operator Results by attached Conversation `id`.
+                    # @param [String] intelligence_configuration_id Filter Operator Results by Intelligence Configuration `id` used to generate them.
+                    # @param [String] operator_id Filter Operator Results by Language Operator `id`.
+                    # @param [String] page_token Token for pagination
+                    # @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 [Enumerable] Enumerable that will yield up to limit results
+                    def stream(conversation_id: :unset, intelligence_configuration_id: :unset, operator_id: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            conversation_id: conversation_id,
+                            intelligence_configuration_id: intelligence_configuration_id,
+                            operator_id: operator_id,
+                            page_token: page_token,
+                            page_size: limits[:page_size], )
+
+                        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 [String] conversation_id Filter Operator Results by attached Conversation `id`.
+                      # @param [String] intelligence_configuration_id Filter Operator Results by Intelligence Configuration `id` used to generate them.
+                      # @param [String] operator_id Filter Operator Results by Language Operator `id`.
+                      # @param [String] page_token Token for pagination
+                    # @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(conversation_id: :unset, intelligence_configuration_id: :unset, operator_id: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'conversationId' => conversation_id,
+                            'intelligenceConfigurationId' => intelligence_configuration_id,
+                            'operatorId' => operator_id,
+                            'pageToken' => page_token,
+                            
+                            '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
+
+                    ##
+                    # When passed a block, yields OperatorResultInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of OperatorResultInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] conversation_id Filter Operator Results by attached Conversation `id`.
+                    # @param [String] intelligence_configuration_id Filter Operator Results by Intelligence Configuration `id` used to generate them.
+                    # @param [String] operator_id Filter Operator Results by Language Operator `id`.
+                    # @param [String] page_token Token for pagination
+                    
+                    # @return [Page] Page of OperatorResultInstance
+                    def page(conversation_id: :unset, intelligence_configuration_id: :unset, operator_id: :unset, page_token: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'conversationId' => conversation_id,
+                            'intelligenceConfigurationId' => intelligence_configuration_id,
+                            'operatorId' => operator_id,
+                            'pageToken' => page_token,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        OperatorResultPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of OperatorResultInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of OperatorResultInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    OperatorResultPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Intelligence.V3.OperatorResultList>'
+                    end
+                end
+
+
+                class OperatorResultContext < InstanceContext
+                    ##
+                    # Initialize the OperatorResultContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] operator_result_id Operator Result id (TTID)
+                    # @return [OperatorResultContext] OperatorResultContext
+                    def initialize(version, operator_result_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { operator_result_id: operator_result_id,  }
+                        @uri = "/OperatorResults/#{@solution[:operator_result_id]}"
+
+                        
+                    end
+                    ##
+                    # Delete the OperatorResultInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                        OperatorResultInstance.new(
+                          @version,
+                          response.body,
+                            operator_result_id: @solution[:operator_result_id],
+                        )
+                        
+                    end
+
+                    ##
+                    # Delete the OperatorResultInstanceMetadata
+                    # @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)
+                          operatorResult_instance = OperatorResultInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          OperatorResultInstanceMetadata.new(@version, operatorResult_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the OperatorResultInstance
+                    # @return [OperatorResultInstance] Fetched OperatorResultInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        OperatorResultInstance.new(
+                            @version,
+                            payload,
+                            operator_result_id: @solution[:operator_result_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the OperatorResultInstanceMetadata
+                    # @return [OperatorResultInstance] Fetched OperatorResultInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        operator_result_instance = OperatorResultInstance.new(
+                            @version,
+                            response.body,
+                            operator_result_id: @solution[:operator_result_id],
+                        )
+                        OperatorResultInstanceMetadata.new(
+                            @version,
+                            operator_result_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V3.OperatorResultContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V3.OperatorResultContext #{context}>"
+                    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 < TokenPage
+                    ##
+                    # Initialize the OperatorResultPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [OperatorResultPage] OperatorResultPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of OperatorResultInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [OperatorResultInstance] OperatorResultInstance
+                    def get_instance(payload)
+                        OperatorResultInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Intelligence.V3.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::V3PageMetadata>';
+                    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
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this OperatorResult
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [OperatorResultInstance] OperatorResultInstance
+                    def initialize(version, payload , operator_result_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'code' => payload['code'],
+                            'message' => payload['message'],
+                            'http_status_code' => payload['http_status_code'],
+                            'user_error' => payload['user_error'],
+                            'params' => payload['params'],
+                            'output_format' => payload['output_format'],
+                            'id' => payload['id'],
+                            'account_id' => payload['account_id'],
+                            'intelligence_configuration' => payload['intelligence_configuration'],
+                            'conversation_id' => payload['conversation_id'],
+                            'operator' => payload['operator'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'reference_ids' => payload['reference_ids'],
+                            'execution_details' => payload['execution_details'],
+                            'metadata' => payload['metadata'],
+                            'result' => payload['result'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'operator_result_id' => operator_result_id  || @properties['operator_result_id']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [OperatorResultContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = OperatorResultContext.new(@version , @params['operator_result_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Twilio-specific error code
+                    def code
+                        @properties['code']
+                    end
+                    
+                    ##
+                    # @return [String] A human readable error message
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [String] HTTP response status code
+                    def http_status_code
+                        @properties['http_status_code']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Whether the error is a user error (true) or a system error (false)
+                    def user_error
+                        @properties['user_error']
+                    end
+                    
+                    ##
+                    # @return [Hash<String, String>] A map of parameters related to the error, for example, a `params.twilioErrorCodeUrl` might hold a URL or link to additional information
+                    def params
+                        @properties['params']
+                    end
+                    
+                    ##
+                    # @return [String] The output format set on the Operator that generated this result. Determines the structure of the `result` object.
+                    def output_format
+                        @properties['output_format']
+                    end
+                    
+                    ##
+                    # @return [String] A unique identifier for the Operator Result. Assigned by Twilio (TTID).
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The ID of the Account that created the Language Operator.
+                    def account_id
+                        @properties['account_id']
+                    end
+                    
+                    ##
+                    # @return [IntelligenceConfigurationReference] 
+                    def intelligence_configuration
+                        @properties['intelligence_configuration']
+                    end
+                    
+                    ##
+                    # @return [String] The `id` of the Conversation attached to the Operator Result.
+                    def conversation_id
+                        @properties['conversation_id']
+                    end
+                    
+                    ##
+                    # @return [OperatorReference] 
+                    def operator
+                        @properties['operator']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp for when the Operator Result was created.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The `id`s of objects related to this Operator Result.
+                    def reference_ids
+                        @properties['reference_ids']
+                    end
+                    
+                    ##
+                    # @return [ExecutionDetails] 
+                    def execution_details
+                        @properties['execution_details']
+                    end
+                    
+                    ##
+                    # @return [OperatorResultsResponseBaseMetadata] 
+                    def metadata
+                        @properties['metadata']
+                    end
+                    
+                    ##
+                    # @return [ExtractionResultResult] 
+                    def result
+                        @properties['result']
+                    end
+                    
+                    ##
+                    # Delete the OperatorResultInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the OperatorResultInstance
+                    # @return [OperatorResultInstance] Fetched OperatorResultInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V3.OperatorResultInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V3.OperatorResultInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end