manticore-client 1.0.0

data/lib/manticore/client/models/search_request.rb

@@ -0,0 +1,382 @@
+=begin
+#Manticore Search Client
+
+#Сlient for Manticore Search. 
+
+The version of the OpenAPI document: 5.0.0
+Contact: info@manticoresearch.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Manticore::Client
+  # Request object for search operation
+  class SearchRequest
+    # The table to perform the search on
+    attr_accessor :table
+
+    attr_accessor :query
+
+    # Join clause to combine search data from multiple tables
+    attr_accessor :join
+
+    attr_accessor :highlight
+
+    # Maximum number of results to return
+    attr_accessor :limit
+
+    attr_accessor :knn
+
+    # Defines aggregation settings for grouping results
+    attr_accessor :aggs
+
+    # Expressions to calculate additional values for the result
+    attr_accessor :expressions
+
+    # Maximum number of matches allowed in the result
+    attr_accessor :max_matches
+
+    # Starting point for pagination of the result
+    attr_accessor :offset
+
+    # Additional search options
+    attr_accessor :options
+
+    # Enable or disable profiling of the search request
+    attr_accessor :profile
+
+    attr_accessor :sort
+
+    attr_accessor :_source
+
+    # Enable or disable result weight calculation used for sorting
+    attr_accessor :track_scores
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'table' => :'table',
+        :'query' => :'query',
+        :'join' => :'join',
+        :'highlight' => :'highlight',
+        :'limit' => :'limit',
+        :'knn' => :'knn',
+        :'aggs' => :'aggs',
+        :'expressions' => :'expressions',
+        :'max_matches' => :'max_matches',
+        :'offset' => :'offset',
+        :'options' => :'options',
+        :'profile' => :'profile',
+        :'sort' => :'sort',
+        :'_source' => :'_source',
+        :'track_scores' => :'track_scores'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'table' => :'String',
+        :'query' => :'SearchQuery',
+        :'join' => :'Array<Join>',
+        :'highlight' => :'Highlight',
+        :'limit' => :'Integer',
+        :'knn' => :'KnnQuery',
+        :'aggs' => :'Hash<String, Aggregation>',
+        :'expressions' => :'Hash<String, String>',
+        :'max_matches' => :'Integer',
+        :'offset' => :'Integer',
+        :'options' => :'Object',
+        :'profile' => :'Boolean',
+        :'sort' => :'Object',
+        :'_source' => :'Object',
+        :'track_scores' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sort',
+        :'_source',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Manticore::Client::SearchRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Manticore::Client::SearchRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'table')
+        self.table = attributes[:'table']
+      else
+        self.table = nil
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'join')
+        if (value = attributes[:'join']).is_a?(Array)
+          self.join = value
+        end
+      end
+
+      if attributes.key?(:'highlight')
+        self.highlight = attributes[:'highlight']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'knn')
+        self.knn = attributes[:'knn']
+      end
+
+      if attributes.key?(:'aggs')
+        if (value = attributes[:'aggs']).is_a?(Hash)
+          self.aggs = value
+        end
+      end
+
+      if attributes.key?(:'expressions')
+        if (value = attributes[:'expressions']).is_a?(Hash)
+          self.expressions = value
+        end
+      end
+
+      if attributes.key?(:'max_matches')
+        self.max_matches = attributes[:'max_matches']
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      end
+
+      if attributes.key?(:'options')
+        self.options = attributes[:'options']
+      end
+
+      if attributes.key?(:'profile')
+        self.profile = attributes[:'profile']
+      end
+
+      if attributes.key?(:'sort')
+        self.sort = attributes[:'sort']
+      end
+
+      if attributes.key?(:'_source')
+        self._source = attributes[:'_source']
+      end
+
+      if attributes.key?(:'track_scores')
+        self.track_scores = attributes[:'track_scores']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @table.nil?
+        invalid_properties.push('invalid value for "table", table cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @table.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] table Value to be assigned
+    def table=(table)
+      if table.nil?
+        fail ArgumentError, 'table cannot be nil'
+      end
+
+      @table = table
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          table == o.table &&
+          query == o.query &&
+          join == o.join &&
+          highlight == o.highlight &&
+          limit == o.limit &&
+          knn == o.knn &&
+          aggs == o.aggs &&
+          expressions == o.expressions &&
+          max_matches == o.max_matches &&
+          offset == o.offset &&
+          options == o.options &&
+          profile == o.profile &&
+          sort == o.sort &&
+          _source == o._source &&
+          track_scores == o.track_scores
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [table, query, join, highlight, limit, knn, aggs, expressions, max_matches, offset, options, profile, sort, _source, track_scores].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Manticore::Client.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/manticore/client/models/search_response.rb

@@ -0,0 +1,281 @@
+=begin
+#Manticore Search Client
+
+#Сlient for Manticore Search. 
+
+The version of the OpenAPI document: 5.0.0
+Contact: info@manticoresearch.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Manticore::Client
+  # Response object containing the results of a search request
+  class SearchResponse
+    # Time taken to execute the search
+    attr_accessor :took
+
+    # Indicates whether the search operation timed out
+    attr_accessor :timed_out
+
+    # Aggregated search results grouped by the specified criteria
+    attr_accessor :aggregations
+
+    attr_accessor :hits
+
+    # Profile information about the search execution, if profiling is enabled
+    attr_accessor :profile
+
+    # Scroll token to be used fo pagination
+    attr_accessor :scroll
+
+    # Warnings encountered during the search operation
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'took' => :'took',
+        :'timed_out' => :'timed_out',
+        :'aggregations' => :'aggregations',
+        :'hits' => :'hits',
+        :'profile' => :'profile',
+        :'scroll' => :'scroll',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'took' => :'Integer',
+        :'timed_out' => :'Boolean',
+        :'aggregations' => :'Object',
+        :'hits' => :'SearchResponseHits',
+        :'profile' => :'Object',
+        :'scroll' => :'String',
+        :'warning' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Manticore::Client::SearchResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Manticore::Client::SearchResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'took')
+        self.took = attributes[:'took']
+      end
+
+      if attributes.key?(:'timed_out')
+        self.timed_out = attributes[:'timed_out']
+      end
+
+      if attributes.key?(:'aggregations')
+        self.aggregations = attributes[:'aggregations']
+      end
+
+      if attributes.key?(:'hits')
+        self.hits = attributes[:'hits']
+      end
+
+      if attributes.key?(:'profile')
+        self.profile = attributes[:'profile']
+      end
+
+      if attributes.key?(:'scroll')
+        self.scroll = attributes[:'scroll']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          took == o.took &&
+          timed_out == o.timed_out &&
+          aggregations == o.aggregations &&
+          hits == o.hits &&
+          profile == o.profile &&
+          scroll == o.scroll &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [took, timed_out, aggregations, hits, profile, scroll, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Manticore::Client.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end