Class: Algolia::Analytics::TopHitWithAnalytics

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/analytics/top_hit_with_analytics.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TopHitWithAnalytics

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 73

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

  if attributes.key?(:count)
    self.count = attributes[:count]
  else
    self.count = nil
  end

  if attributes.key?(:click_through_rate)
    self.click_through_rate = attributes[:click_through_rate]
  else
    self.click_through_rate = nil
  end

  if attributes.key?(:conversion_rate)
    self.conversion_rate = attributes[:conversion_rate]
  else
    self.conversion_rate = nil
  end

  if attributes.key?(:tracked_hit_count)
    self.tracked_hit_count = attributes[:tracked_hit_count]
  else
    self.tracked_hit_count = nil
  end

  if attributes.key?(:click_count)
    self.click_count = attributes[:click_count]
  else
    self.click_count = nil
  end

  if attributes.key?(:conversion_count)
    self.conversion_count = attributes[:conversion_count]
  else
    self.conversion_count = nil
  end
end

Instance Attribute Details

#click_count ⇒ Object

Number of clicks associated with this search.



25
26
27
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 25

def click_count
  @click_count
end

#click_through_rate ⇒ Object

Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn’t receive any search requests with ‘clickAnalytics` set to true.



16
17
18
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 16

def click_through_rate
  @click_through_rate
end

#conversion_count ⇒ Object

Number of conversions from this search.



28
29
30
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 28

def conversion_count
  @conversion_count
end

#conversion_rate ⇒ Object

Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn’t receive any search requests with ‘clickAnalytics` set to true.



19
20
21
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 19

def conversion_rate
  @conversion_rate
end

#count ⇒ Object

Number of occurrences.



13
14
15
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 13

def count
  @count
end

#hit ⇒ Object

Object ID of a record that’s returned as a search result.



10
11
12
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 10

def hit
  @hit
end

#tracked_hit_count ⇒ Object

Number of tracked searches. Tracked searches are search requests where the ‘clickAnalytics` parameter is true.



22
23
24
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 22

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



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
232
233
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 193

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

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



44
45
46
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 44

def self.acceptable_attributes
  attribute_map.values
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
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 31

def self.attribute_map
  {
    :hit => :hit,
    :count => :count,
    :click_through_rate => :clickThroughRate,
    :conversion_rate => :conversionRate,
    :tracked_hit_count => :trackedHitCount,
    :click_count => :clickCount,
    :conversion_count => :conversionCount
  }
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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 166

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



62
63
64
65
66
67
68
69
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 62

def self.openapi_nullable
  Set.new(
    [
      :click_through_rate,
      :conversion_rate
    ]
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 49

def self.types_mapping
  {
    :hit => :"String",
    :count => :"Integer",
    :click_through_rate => :"Float",
    :conversion_rate => :"Float",
    :tracked_hit_count => :"Integer",
    :click_count => :"Integer",
    :conversion_count => :"Integer"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 139

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    hit == other.hit &&
    count == other.count &&
    click_through_rate == other.click_through_rate &&
    conversion_rate == other.conversion_rate &&
    tracked_hit_count == other.tracked_hit_count &&
    click_count == other.click_count &&
    conversion_count == other.conversion_count
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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 272

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


153
154
155
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



159
160
161
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 159

def hash
  [hit, count, click_through_rate, conversion_rate, tracked_hit_count, click_count, conversion_count].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



243
244
245
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 243

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 253

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 



247
248
249
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 247

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



237
238
239
 
# File 'lib/algolia/models/analytics/top_hit_with_analytics.rb', line 237

def to_s
  to_hash.to_s
end