Class: SiteimproveAPIClient::VisibilityScoreHistoryItem

Inherits:
Object
  • Object
show all
Defined in:
lib/siteimprove_api_client/models/visibility_score_history_item.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VisibilityScoreHistoryItem

Initializes the object



63
64
65
66
67
68
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
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 63

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SiteimproveAPIClient::VisibilityScoreHistoryItem` 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))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SiteimproveAPIClient::VisibilityScoreHistoryItem`. 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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'data')
    if (value = attributes[:'data']).is_a?(Hash)
      self.data = value
    end
  end

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

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

Instance Attribute Details

#data ⇒ Object

The numeric data value for this point in time.



22
23
24
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 22

def data
  @data
end

#name ⇒ Object

The name of your site / your competitor



19
20
21
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 19

def name
  @name
end

#search_engine_visibility ⇒ Object

The search engine visibility index



25
26
27
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 25

def search_engine_visibility
  @search_engine_visibility
end

#timestamp ⇒ Object

Timestamp represented using ISO-8601



28
29
30
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 28

def timestamp
  @timestamp
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 41

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
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 31

def self.attribute_map
  {
    :'name' => :'name',
    :'data' => :'data',
    :'search_engine_visibility' => :'search_engine_visibility',
    :'timestamp' => :'timestamp'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



144
145
146
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 144

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 46

def self.openapi_types
  {
    :'name' => :'String',
    :'data' => :'Hash<String, Float>',
    :'search_engine_visibility' => :'Integer',
    :'timestamp' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



120
121
122
123
124
125
126
127
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 120

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      data == o.data &&
      search_engine_visibility == o.search_engine_visibility &&
      timestamp == o.timestamp
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 175

def _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
  else # model
    # models (e.g. Pet) or oneOf
    klass = SiteimproveAPIClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 246

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 151

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


131
132
133
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 131

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



137
138
139
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 137

def hash
  [name, data, search_engine_visibility, timestamp].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 97

def list_invalid_properties
  invalid_properties = Array.new
  if @search_engine_visibility.nil?
    invalid_properties.push('invalid value for "search_engine_visibility", search_engine_visibility cannot be nil.')
  end

  if @timestamp.nil?
    invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



222
223
224
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 222

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 228

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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_s ⇒ String

Returns the string representation of the object



216
217
218
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 216

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



112
113
114
115
116
 
# File 'lib/siteimprove_api_client/models/visibility_score_history_item.rb', line 112

def valid?
  return false if @search_engine_visibility.nil?
  return false if @timestamp.nil?
  true
end