Class: SiteimproveAPIClient::IgnoredIssueDecision

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IgnoredIssueDecision

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

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

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

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

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

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

  if attributes.key?(:'decided_for')
    self.decided_for = attributes[:'decided_for']
  else
    self.decided_for = 'entire_site'
  end

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

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

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

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



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

def _links
  @_links
end

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



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

def _siteimprove
  @_siteimprove
end

#chapter ⇒ Object

WCAG chapter describing the issue you’re making a decision for



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

def chapter
  @chapter
end

#check ⇒ Object

WCAG chapter description



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

def check
  @check
end

#check_id ⇒ Object

Check enumerator



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

def check_id
  @check_id
end

#created_by ⇒ Object

Decision made by



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

def created_by
  @created_by
end

#created_ts ⇒ Object

Decision made at date



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

def created_ts
  @created_ts
end

#decided_for ⇒ Object

Scope of the decision



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

def decided_for
  @decided_for
end

#note ⇒ Object

Decision note



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

def note
  @note
end

#priority ⇒ Object

WCAG issue priority



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

def priority
  @priority
end

#severity ⇒ Object

WCAG issue severity



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

def severity
  @severity
end

#subtype ⇒ Object

Decision type



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

def subtype
  @subtype
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 75

def self.attribute_map
  {
    :'chapter' => :'chapter',
    :'check' => :'check',
    :'check_id' => :'check_id',
    :'created_by' => :'created_by',
    :'created_ts' => :'created_ts',
    :'decided_for' => :'decided_for',
    :'note' => :'note',
    :'priority' => :'priority',
    :'severity' => :'severity',
    :'subtype' => :'subtype',
    :'_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



313
314
315
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 313

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/ignored_issue_decision.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'chapter' => :'String',
    :'check' => :'String',
    :'check_id' => :'Integer',
    :'created_by' => :'String',
    :'created_ts' => :'Time',
    :'decided_for' => :'String',
    :'note' => :'String',
    :'priority' => :'String',
    :'severity' => :'String',
    :'subtype' => :'String',
    :'_links' => :'Links3',
    :'_siteimprove' => :'Siteimprove1'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      chapter == o.chapter &&
      check == o.check &&
      check_id == o.check_id &&
      created_by == o.created_by &&
      created_ts == o.created_ts &&
      decided_for == o.decided_for &&
      note == o.note &&
      priority == o.priority &&
      severity == o.severity &&
      subtype == o.subtype &&
      _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



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
373
374
375
376
377
378
379
380
381
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 344

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



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

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 320

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


300
301
302
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 300

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



306
307
308
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 306

def hash
  [chapter, check, check_id, created_by, created_ts, decided_for, note, priority, severity, subtype, _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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 195

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

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

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

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

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



391
392
393
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 391

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 397

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



385
386
387
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 385

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/siteimprove_api_client/models/ignored_issue_decision.rb', line 222

def valid?
  return false if @check_id.nil?
  return false if @decided_for.nil?
  decided_for_validator = EnumAttributeValidator.new('String', ["entire_site", "individual_page"])
  return false unless decided_for_validator.valid?(@decided_for)
  return false if @priority.nil?
  priority_validator = EnumAttributeValidator.new('String', ["aaa", "aa", "a"])
  return false unless priority_validator.valid?(@priority)
  return false if @severity.nil?
  severity_validator = EnumAttributeValidator.new('String', ["review", "warning", "error"])
  return false unless severity_validator.valid?(@severity)
  return false if @subtype.nil?
  subtype_validator = EnumAttributeValidator.new('String', ["ignored", "cant_fix", "approved"])
  return false unless subtype_validator.valid?(@subtype)
  true
end