Class: SiteimproveAPIClient::A11YHistoryValue

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ A11YHistoryValue

Initializes the object

Parameters:

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

    Model attributes in the form of hash



123
124
125
126
127
128
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
170
171
172
173
174
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
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#a_issues ⇒ Object

Total number of WCAG level A issues across all pages



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

def a_issues
  @a_issues
end

#a_occurrences ⇒ Object

Total number of WCAG level A issue occurrences across all pages



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

def a_occurrences
  @a_occurrences
end

#aa_issues ⇒ Object

Total number of WCAG level AA issues across all pages



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

def aa_issues
  @aa_issues
end

#aa_occurrences ⇒ Object

Total number of WCAG level AA issue occurrences across all pages



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

def aa_occurrences
  @aa_occurrences
end

#aaa_issues ⇒ Object

Total number of WCAG level AAA issues across all pages



31
32
33
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 31

def aaa_issues
  @aaa_issues
end

#aaa_occurrences ⇒ Object

Total number of WCAG level AAA issue occurrences across all pages



34
35
36
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 34

def aaa_occurrences
  @aaa_occurrences
end

#number_of_pages ⇒ Object

Total number of pages on the site



37
38
39
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 37

def number_of_pages
  @number_of_pages
end

#si_best_practice_issues ⇒ Object

Total number of accessibility best practice issues across all pages



40
41
42
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 40

def si_best_practice_issues
  @si_best_practice_issues
end

#si_best_practice_occurrences ⇒ Object

Total number of accessibility best practice issue occurrences across all pages



43
44
45
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 43

def si_best_practice_occurrences
  @si_best_practice_occurrences
end

#timestamp ⇒ Object

Timestamp for data point.



46
47
48
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 46

def timestamp
  @timestamp
end

#total_best_practice_issues ⇒ Object

Total number of best practice issues across all pages



49
50
51
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 49

def total_best_practice_issues
  @total_best_practice_issues
end

#total_best_practice_occurrences ⇒ Object

Total number of best practice issue occurrences across all pages



52
53
54
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 52

def total_best_practice_occurrences
  @total_best_practice_occurrences
end

#total_wcag_conformance_issues ⇒ Object

Total number of WCAG conformance issues across all pages



55
56
57
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 55

def total_wcag_conformance_issues
  @total_wcag_conformance_issues
end

#total_wcag_conformance_occurrences ⇒ Object

Total number of WCAG conformance issue occurrences across all pages



58
59
60
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 58

def total_wcag_conformance_occurrences
  @total_wcag_conformance_occurrences
end

#wai_aria_issues ⇒ Object

Total number of WAI-ARIA conformance issues across all pages



61
62
63
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 61

def wai_aria_issues
  @wai_aria_issues
end

#wai_aria_occurrences ⇒ Object

Total number of WAI-ARIA conformance issue occurrences across all pages



64
65
66
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 64

def wai_aria_occurrences
  @wai_aria_occurrences
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 67

def self.attribute_map
  {
    :'a_issues' => :'a_issues',
    :'a_occurrences' => :'a_occurrences',
    :'aa_issues' => :'aa_issues',
    :'aa_occurrences' => :'aa_occurrences',
    :'aaa_issues' => :'aaa_issues',
    :'aaa_occurrences' => :'aaa_occurrences',
    :'number_of_pages' => :'number_of_pages',
    :'si_best_practice_issues' => :'si_best_practice_issues',
    :'si_best_practice_occurrences' => :'si_best_practice_occurrences',
    :'timestamp' => :'timestamp',
    :'total_best_practice_issues' => :'total_best_practice_issues',
    :'total_best_practice_occurrences' => :'total_best_practice_occurrences',
    :'total_wcag_conformance_issues' => :'total_wcag_conformance_issues',
    :'total_wcag_conformance_occurrences' => :'total_wcag_conformance_occurrences',
    :'wai_aria_issues' => :'wai_aria_issues',
    :'wai_aria_occurrences' => :'wai_aria_occurrences'
  }
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



332
333
334
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 332

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 94

def self.openapi_types
  {
    :'a_issues' => :'Integer',
    :'a_occurrences' => :'Integer',
    :'aa_issues' => :'Integer',
    :'aa_occurrences' => :'Integer',
    :'aaa_issues' => :'Integer',
    :'aaa_occurrences' => :'Integer',
    :'number_of_pages' => :'Integer',
    :'si_best_practice_issues' => :'Integer',
    :'si_best_practice_occurrences' => :'Integer',
    :'timestamp' => :'Time',
    :'total_best_practice_issues' => :'Integer',
    :'total_best_practice_occurrences' => :'Integer',
    :'total_wcag_conformance_issues' => :'Integer',
    :'total_wcag_conformance_occurrences' => :'Integer',
    :'wai_aria_issues' => :'Integer',
    :'wai_aria_occurrences' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      a_issues == o.a_issues &&
      a_occurrences == o.a_occurrences &&
      aa_issues == o.aa_issues &&
      aa_occurrences == o.aa_occurrences &&
      aaa_issues == o.aaa_issues &&
      aaa_occurrences == o.aaa_occurrences &&
      number_of_pages == o.number_of_pages &&
      si_best_practice_issues == o.si_best_practice_issues &&
      si_best_practice_occurrences == o.si_best_practice_occurrences &&
      timestamp == o.timestamp &&
      total_best_practice_issues == o.total_best_practice_issues &&
      total_best_practice_occurrences == o.total_best_practice_occurrences &&
      total_wcag_conformance_issues == o.total_wcag_conformance_issues &&
      total_wcag_conformance_occurrences == o.total_wcag_conformance_occurrences &&
      wai_aria_issues == o.wai_aria_issues &&
      wai_aria_occurrences == o.wai_aria_occurrences
end

#_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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 363

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 434

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 339

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


319
320
321
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



325
326
327
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 325

def hash
  [a_issues, a_occurrences, aa_issues, aa_occurrences, aaa_issues, aaa_occurrences, number_of_pages, si_best_practice_issues, si_best_practice_occurrences, timestamp, total_best_practice_issues, total_best_practice_occurrences, total_wcag_conformance_issues, total_wcag_conformance_occurrences, wai_aria_issues, wai_aria_occurrences].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 203

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



410
411
412
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 410

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 416

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

Returns:

  • (String) —

    String presentation of the object



404
405
406
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 404

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/siteimprove_api_client/models/a11_y_history_value.rb', line 274

def valid?
  return false if @a_issues.nil?
  return false if @a_occurrences.nil?
  return false if @aa_issues.nil?
  return false if @aa_occurrences.nil?
  return false if @aaa_issues.nil?
  return false if @aaa_occurrences.nil?
  return false if @number_of_pages.nil?
  return false if @si_best_practice_issues.nil?
  return false if @si_best_practice_occurrences.nil?
  return false if @timestamp.nil?
  return false if @total_best_practice_issues.nil?
  return false if @total_best_practice_occurrences.nil?
  return false if @total_wcag_conformance_issues.nil?
  return false if @total_wcag_conformance_occurrences.nil?
  return false if @wai_aria_issues.nil?
  return false if @wai_aria_occurrences.nil?
  true
end