Class: SiteimproveAPIClient::SummaryIssue

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SummaryIssue

Initializes the object



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

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

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

  if attributes.key?(:'severity')
    self.severity = attributes[:'severity']
  else
    self.severity = 'review'
  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.



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

def _links
  @_links
end

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



29
30
31
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 29

def _siteimprove
  @_siteimprove
end

#conformance_level ⇒ Object

WCAG conformance level aa, aaa



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

def conformance_level
  @conformance_level
end

#issues ⇒ Object

Number of issues with this conformance level and severity



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

def issues
  @issues
end

#severity ⇒ Object

WCAG severity level warning, review



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

def severity
  @severity
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 54

def self.attribute_map
  {
    :'conformance_level' => :'conformance_level',
    :'issues' => :'issues',
    :'severity' => :'severity',
    :'_links' => :'_links',
    :'_siteimprove' => :'_siteimprove'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



205
206
207
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 205

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 70

def self.openapi_types
  {
    :'conformance_level' => :'String',
    :'issues' => :'Integer',
    :'severity' => :'String',
    :'_links' => :'Links17',
    :'_siteimprove' => :'Siteimprove1'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



180
181
182
183
184
185
186
187
188
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conformance_level == o.conformance_level &&
      issues == o.issues &&
      severity == o.severity &&
      _links == o._links &&
      _siteimprove == o._siteimprove
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
271
272
273
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 236

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 307

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



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/summary_issue.rb', line 212

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


192
193
194
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



198
199
200
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 198

def hash
  [conformance_level, issues, severity, _links, _siteimprove].hash
end

#list_invalid_properties ⇒ Object

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 128

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

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



283
284
285
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 283

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 289

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



277
278
279
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 277

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/siteimprove_api_client/models/summary_issue.rb', line 147

def valid?
  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 @issues.nil?
  return false if @severity.nil?
  severity_validator = EnumAttributeValidator.new('String', ["review", "warning", "error"])
  return false unless severity_validator.valid?(@severity)
  true
end