class Algolia::QuerySuggestions::ConfigurationWithIndex

Query Suggestions configuration.

def self._deserialize(type, value)

Returns:
  • (Object) - Deserialized data

Parameters:
  • string () -- value Value to be deserialized
  • string () -- type Data type
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
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::QuerySuggestions.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

def self.acceptable_attributes

Returns all the JSON keys this model knows about
def self.acceptable_attributes
  attribute_map.values
end

def self.attribute_map

Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
  {
    :source_indices => :sourceIndices,
    :languages => :languages,
    :exclude => :exclude,
    :enable_personalization => :enablePersonalization,
    :allow_special_characters => :allowSpecialCharacters,
    :index_name => :indexName
  }
end

def self.build_from_hash(attributes)

Returns:
  • (Object) - Returns the model itself

Parameters:
  • attributes (Hash) -- Model attributes in the form of hash
def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = 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.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

def self.openapi_all_of

List of class defined in allOf (OpenAPI v3)
def self.openapi_all_of
  [
    :"Configuration"
  ]
end

def self.openapi_nullable

List of attributes with nullable: true
def self.openapi_nullable
  Set.new(
    [
      :exclude
    ]
  )
end

def self.types_mapping

Attribute type mapping.
def self.types_mapping
  {
    :source_indices => :"Array<SourceIndex>",
    :languages => :"Languages",
    :exclude => :"Array<String>",
    :enable_personalization => :"Boolean",
    :allow_special_characters => :"Boolean",
    :index_name => :"String"
  }
end

def ==(other)

Parameters:
  • Object (Object) -- to be compared
def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    source_indices == other.source_indices &&
    languages == other.languages &&
    exclude == other.exclude &&
    enable_personalization == other.enable_personalization &&
    allow_special_characters == other.allow_special_characters &&
    index_name == other.index_name
end

def _to_hash(value)

Returns:
  • (Hash) - Returns the value in the form of hash

Parameters:
  • value (Object) -- Any valid value
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

def eql?(other)

Parameters:
  • Object (Object) -- to be compared

Other tags:
    See: the - `==` method
def eql?(other)
  self == other
end

def hash

Returns:
  • (Integer) - Hash code
def hash
  [source_indices, languages, exclude, enable_personalization, allow_special_characters, index_name].hash
end

def initialize(attributes = {})

Parameters:
  • attributes (Hash) -- Model attributes in the form of hash
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::ConfigurationWithIndex` initialize method"
    )
  end
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::ConfigurationWithIndex`. Please check the name to make sure it's valid. List of attributes: " +
          self.class.attribute_map.keys.inspect
      )
    end
    h[k.to_sym] = v
  }
  if attributes.key?(:source_indices)
    if (value = attributes[:source_indices]).is_a?(Array)
      self.source_indices = value
    end
  else
    self.source_indices = nil
  end
  if attributes.key?(:languages)
    self.languages = attributes[:languages]
  end
  if attributes.key?(:exclude)
    if (value = attributes[:exclude]).is_a?(Array)
      self.exclude = value
    end
  end
  if attributes.key?(:enable_personalization)
    self.enable_personalization = attributes[:enable_personalization]
  end
  if attributes.key?(:allow_special_characters)
    self.allow_special_characters = attributes[:allow_special_characters]
  end
  if attributes.key?(:index_name)
    self.index_name = attributes[:index_name]
  else
    self.index_name = nil
  end
end

def source_indices=(source_indices)

Parameters:
  • source_indices (Object) -- Value to be assigned
def source_indices=(source_indices)
  if source_indices.nil?
    raise ArgumentError, "source_indices cannot be nil"
  end
  if source_indices.length < 1
    raise(
      ArgumentError,
      "invalid value for \"source_indices\", number of items must be greater than or equal to 1."
    )
  end
  @source_indices = source_indices
end

def to_body

Returns:
  • (Hash) - Returns the object in the form of hash
def to_body
  to_hash
end

def to_hash

Returns:
  • (Hash) - Returns the object in the form of hash
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

def to_json(*_args)

def to_json(*_args)
  to_hash.to_json
end

def to_s

Returns:
  • (String) - String presentation of the object
def to_s
  to_hash.to_s
end