Class: Algolia::Search::DeleteByParams

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/search/delete_by_params.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeleteByParams

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::DeleteByParams` 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::DeleteByParams`. 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?(:facet_filters)
    self.facet_filters = attributes[:facet_filters]
  end

  if attributes.key?(:filters)
    self.filters = attributes[:filters]
  end

  if attributes.key?(:numeric_filters)
    self.numeric_filters = attributes[:numeric_filters]
  end

  if attributes.key?(:tag_filters)
    self.tag_filters = attributes[:tag_filters]
  end

  if attributes.key?(:around_lat_lng)
    self.around_lat_lng = attributes[:around_lat_lng]
  end

  if attributes.key?(:around_radius)
    self.around_radius = attributes[:around_radius]
  end

  if attributes.key?(:inside_bounding_box)
    self.inside_bounding_box = attributes[:inside_bounding_box]
  end

  if attributes.key?(:inside_polygon)
    if (value = attributes[:inside_polygon]).is_a?(Array)
      self.inside_polygon = value
    end
  end
end

Instance Attribute Details

#around_lat_lng ⇒ Object

Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the ‘aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.



21
22
23
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 21

def around_lat_lng
  @around_lat_lng
end

#around_radius ⇒ Object

Returns the value of attribute around_radius.



23
24
25
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 23

def around_radius
  @around_radius
end

#facet_filters ⇒ Object

Returns the value of attribute facet_filters.



11
12
13
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 11

def facet_filters
  @facet_filters
end

#filters ⇒ Object

Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ‘<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - Ranges. `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can’t use ‘NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can’t combine conjunctions (‘AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](www.algolia.com/doc/guides/managing-results/refine-results/filtering/).



14
15
16
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 14

def filters
  @filters
end

#inside_bounding_box ⇒ Object

Returns the value of attribute inside_bounding_box.



25
26
27
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 25

def inside_bounding_box
  @inside_bounding_box
end

#inside_polygon ⇒ Object

Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify ‘insideBoundingBox`.



28
29
30
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 28

def inside_polygon
  @inside_polygon
end

#numeric_filters ⇒ Object

Returns the value of attribute numeric_filters.



16
17
18
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 16

def numeric_filters
  @numeric_filters
end

#tag_filters ⇒ Object

Returns the value of attribute tag_filters.



18
19
20
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 18

def tag_filters
  @tag_filters
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 191

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::Search.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

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 31

def self.attribute_map
  {
    :facet_filters => :facetFilters,
    :filters => :filters,
    :numeric_filters => :numericFilters,
    :tag_filters => :tagFilters,
    :around_lat_lng => :aroundLatLng,
    :around_radius => :aroundRadius,
    :inside_bounding_box => :insideBoundingBox,
    :inside_polygon => :insidePolygon
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 164

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
62
63
64
65
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 59

def self.openapi_nullable
  Set.new(
    [
      :inside_bounding_box
    ]
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 45

def self.types_mapping
  {
    :facet_filters => :"FacetFilters",
    :filters => :"String",
    :numeric_filters => :"NumericFilters",
    :tag_filters => :"TagFilters",
    :around_lat_lng => :"String",
    :around_radius => :"AroundRadius",
    :inside_bounding_box => :"InsideBoundingBox",
    :inside_polygon => :"Array<Array<Float>>"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 127

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    facet_filters == other.facet_filters &&
    filters == other.filters &&
    numeric_filters == other.numeric_filters &&
    tag_filters == other.tag_filters &&
    around_lat_lng == other.around_lat_lng &&
    around_radius == other.around_radius &&
    inside_bounding_box == other.inside_bounding_box &&
    inside_polygon == other.inside_polygon
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 270

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


142
143
144
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 148

def hash
  [
    facet_filters,
    filters,
    numeric_filters,
    tag_filters,
    around_lat_lng,
    around_radius,
    inside_bounding_box,
    inside_polygon
  ].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 241

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 251

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

#to_json(*_args) ⇒ Object 



245
246
247
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 245

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/algolia/models/search/delete_by_params.rb', line 235

def to_s
  to_hash.to_s
end