Class: Algolia::Composition::SearchResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/composition/search_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/algolia/models/composition/search_response.rb', line 51

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::SearchResponse` initialize method"
    )
  end

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

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

  # add extra attribute to additional_properties
  self.additional_properties ||= {}
  self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



16
17
18
 
# File 'lib/algolia/models/composition/search_response.rb', line 16

def additional_properties
  @additional_properties
end

#compositions ⇒ Object

Returns the value of attribute compositions.



11
12
13
 
# File 'lib/algolia/models/composition/search_response.rb', line 11

def compositions
  @compositions
end

#results ⇒ Object

Search results.



14
15
16
 
# File 'lib/algolia/models/composition/search_response.rb', line 14

def results
  @results
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/algolia/models/composition/search_response.rb', line 129

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



19
20
21
22
23
24
 
# File 'lib/algolia/models/composition/search_response.rb', line 19

def self.attribute_map
  {
    :compositions => :compositions,
    :results => :results
  }
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



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/composition/search_response.rb', line 100

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

  # add extra attribute to transformed_hash
  transformed_hash.merge!(attributes.reject { |k, _| attribute_map.key?(k.to_sym) })
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



42
43
44
45
46
47
 
# File 'lib/algolia/models/composition/search_response.rb', line 42

def self.openapi_all_of
  [
    :"CompositionBaseSearchResponse",
    :"SearchResults"
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



35
36
37
38
39
 
# File 'lib/algolia/models/composition/search_response.rb', line 35

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

.types_mapping ⇒ Object

Attribute type mapping.



27
28
29
30
31
32
 
# File 'lib/algolia/models/composition/search_response.rb', line 27

def self.types_mapping
  {
    :compositions => :"CompositionsSearchResponse",
    :results => :"Array<SearchResultsItem>"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



78
79
80
81
82
83
 
# File 'lib/algolia/models/composition/search_response.rb', line 78

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    compositions == other.compositions &&
    results == other.results
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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/algolia/models/composition/search_response.rb', line 213

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


87
88
89
 
# File 'lib/algolia/models/composition/search_response.rb', line 87

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



93
94
95
 
# File 'lib/algolia/models/composition/search_response.rb', line 93

def hash
  [compositions, results].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



179
180
181
 
# File 'lib/algolia/models/composition/search_response.rb', line 179

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/algolia/models/composition/search_response.rb', line 189

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

  # also add attributes from additional_properties to hash
  self.additional_properties&.each_pair do |k, v|
    hash[k.to_sym] = _to_hash(v)
  end

  hash
end

#to_json(*_args) ⇒ Object 



183
184
185
 
# File 'lib/algolia/models/composition/search_response.rb', line 183

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



173
174
175
 
# File 'lib/algolia/models/composition/search_response.rb', line 173

def to_s
  to_hash.to_s
end