Class: SiteimproveAPIClient::ContentCheckSummary

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContentCheckSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 91

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



44
45
46
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 44

def _links
  @_links
end

#id ⇒ Object

Id of this specific content



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

def id
  @id
end

#is_a11y_done ⇒ Object

Indicates whether Accessibility checks are done running



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

def is_a11y_done
  @is_a11y_done
end

#is_done ⇒ Object

Indicates whether the check is done or not



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

def is_done
  @is_done
end

#is_readability_done ⇒ Object

Indicates whether Readability checks are done running



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

def is_readability_done
  @is_readability_done
end

#is_seo_done ⇒ Object

Indicates whether SEO checks are done running



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

def is_seo_done
  @is_seo_done
end

#is_spelling_done ⇒ Object

Indicates whether spelling is done running



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

def is_spelling_done
  @is_spelling_done
end

#size_bytes ⇒ Object

Size of the content in bytes



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

def size_bytes
  @size_bytes
end

#summary ⇒ Object

Returns the value of attribute summary.



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

def summary
  @summary
end

#title ⇒ Object

Title of the content (if any)



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

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 47

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'is_a11y_done' => :'is_a11y_done',
    :'is_done' => :'is_done',
    :'is_readability_done' => :'is_readability_done',
    :'is_seo_done' => :'is_seo_done',
    :'is_spelling_done' => :'is_spelling_done',
    :'size_bytes' => :'size_bytes',
    :'summary' => :'summary',
    :'_links' => :'_links'
  }
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



220
221
222
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 220

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 68

def self.openapi_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'is_a11y_done' => :'Boolean',
    :'is_done' => :'Boolean',
    :'is_readability_done' => :'Boolean',
    :'is_seo_done' => :'Boolean',
    :'is_spelling_done' => :'Boolean',
    :'size_bytes' => :'Integer',
    :'summary' => :'Summary',
    :'_links' => :'Links7'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      is_a11y_done == o.is_a11y_done &&
      is_done == o.is_done &&
      is_readability_done == o.is_readability_done &&
      is_seo_done == o.is_seo_done &&
      is_spelling_done == o.is_spelling_done &&
      size_bytes == o.size_bytes &&
      summary == o.summary &&
      _links == o._links
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 251

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 322

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 227

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


207
208
209
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 213

def hash
  [id, title, is_a11y_done, is_done, is_readability_done, is_seo_done, is_spelling_done, size_bytes, summary, _links].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



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

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

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

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

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

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

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



298
299
300
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 298

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 304

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



292
293
294
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 292

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



178
179
180
181
182
183
184
185
186
 
# File 'lib/siteimprove_api_client/models/content_check_summary.rb', line 178

def valid?
  return false if @id.nil?
  return false if @is_a11y_done.nil?
  return false if @is_done.nil?
  return false if @is_readability_done.nil?
  return false if @is_seo_done.nil?
  return false if @is_spelling_done.nil?
  true
end