Module: Algolia::Recommend::NumericFilters

Defined in:
lib/algolia/models/recommend/numeric_filters.rb

Overview

Filter by numeric facets. **Prefer using the ‘filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.

Class Method Summary collapse

Class Method Details

.build(data) ⇒ Object

Builds the object

Parameters:

  • Data (Mixed) —

    to be matched against the list of oneOf items

Returns:

  • (Object) —

    Returns the model or the data itself



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/algolia/models/recommend/numeric_filters.rb', line 22

def build(data)
  # Go through the list of oneOf items and attempt to identify the appropriate one.
  # Note:
  # - We do not attempt to check whether exactly one item matches.
  # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
  #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
  # - TODO: scalar values are de facto behaving as if they were nullable.
  # - TODO: logging when debugging is set.
  openapi_one_of.each do |klass|
    begin
      # "nullable: true"
      next if klass == :AnyType
      typed_data = find_and_cast_into_type(klass, data)
      return typed_data if typed_data
      # rescue all errors so we keep iterating even if the current item lookup raises
    rescue
    end
  end

  openapi_one_of.include?(:AnyType) ? data : nil
end

.openapi_one_of ⇒ Object

List of class defined in oneOf (OpenAPI v3)



12
13
14
15
16
17
 
# File 'lib/algolia/models/recommend/numeric_filters.rb', line 12

def openapi_one_of
  [
    :"Array<NumericFilters>",
    :"String"
  ]
end