Class: SiteimproveAPIClient::Issue2

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Issue2

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'conformance_level')
    self.conformance_level = attributes[:'conformance_level']
  else
    self.conformance_level = 'aaa'
  end

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

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

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

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

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

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

  if attributes.key?(:'severity')
    self.severity = attributes[:'severity']
  else
    self.severity = 'review'
  end

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



50
51
52
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 50

def _links
  @_links
end

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



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

def _siteimprove
  @_siteimprove
end

#conformance_level ⇒ Object

aa, aaa



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

def conformance_level
  @conformance_level
end

#guideline ⇒ Object

WCAG success criterion superset. See: www.w3.org/TR/WCAG20/



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

def guideline
  @guideline
end

#help ⇒ Object

Returns the value of attribute help.



27
28
29
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 27

def help
  @help
end

#id ⇒ Object

check id 2, .. 135



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

def id
  @id
end

#pages ⇒ Object

Number of pages this issue is found on



30
31
32
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 30

def pages
  @pages
end

#pages_past ⇒ Object

Number of pages this issue was found on in the previous period.



33
34
35
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 33

def pages_past
  @pages_past
end

#pages_total ⇒ Object

Total number of pages on the site.



36
37
38
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 36

def pages_total
  @pages_total
end

#principle ⇒ Object

WCAG issue principle id. See www.w3.org/TR/WCAG20/



39
40
41
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 39

def principle
  @principle
end

#severity ⇒ Object

warning



42
43
44
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 42

def severity
  @severity
end

#success_criterion ⇒ Object

WCAG success criterion id. See www.w3.org/TR/WCAG20/



45
46
47
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 45

def success_criterion
  @success_criterion
end

#success_criterion_title ⇒ Object

Textual title of the WCAG success criterion.



48
49
50
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 48

def success_criterion_title
  @success_criterion_title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 77

def self.attribute_map
  {
    :'id' => :'id',
    :'conformance_level' => :'conformance_level',
    :'guideline' => :'guideline',
    :'help' => :'help',
    :'pages' => :'pages',
    :'pages_past' => :'pages_past',
    :'pages_total' => :'pages_total',
    :'principle' => :'principle',
    :'severity' => :'severity',
    :'success_criterion' => :'success_criterion',
    :'success_criterion_title' => :'success_criterion_title',
    :'_links' => :'_links',
    :'_siteimprove' => :'_siteimprove'
  }
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



304
305
306
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 304

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



120
121
122
123
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 120

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 101

def self.openapi_types
  {
    :'id' => :'Integer',
    :'conformance_level' => :'String',
    :'guideline' => :'String',
    :'help' => :'Help1',
    :'pages' => :'Integer',
    :'pages_past' => :'Integer',
    :'pages_total' => :'Integer',
    :'principle' => :'Integer',
    :'severity' => :'String',
    :'success_criterion' => :'String',
    :'success_criterion_title' => :'String',
    :'_links' => :'Links16',
    :'_siteimprove' => :'Siteimprove1'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      conformance_level == o.conformance_level &&
      guideline == o.guideline &&
      help == o.help &&
      pages == o.pages &&
      pages_past == o.pages_past &&
      pages_total == o.pages_total &&
      principle == o.principle &&
      severity == o.severity &&
      success_criterion == o.success_criterion &&
      success_criterion_title == o.success_criterion_title &&
      _links == o._links &&
      _siteimprove == o._siteimprove
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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 335

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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 406

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 311

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


291
292
293
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 297

def hash
  [id, conformance_level, guideline, help, pages, pages_past, pages_total, principle, severity, success_criterion, success_criterion_title, _links, _siteimprove].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



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

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

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

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

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

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

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

  if @severity.nil?
    invalid_properties.push('invalid value for "severity", severity 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



382
383
384
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 382

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 388

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



376
377
378
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 376

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/siteimprove_api_client/models/issue2.rb', line 234

def valid?
  return false if @id.nil?
  return false if @conformance_level.nil?
  conformance_level_validator = EnumAttributeValidator.new('String', ["aaa", "aa", "a"])
  return false unless conformance_level_validator.valid?(@conformance_level)
  return false if @pages.nil?
  return false if @pages_past.nil?
  return false if @pages_total.nil?
  return false if @principle.nil?
  return false if @severity.nil?
  severity_validator = EnumAttributeValidator.new('String', ["review", "warning", "error"])
  return false unless severity_validator.valid?(@severity)
  true
end