Class: SiteimproveAPIClient::ContentCheckReadability

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContentCheckReadability

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 107

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



38
39
40
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 38

def _links
  @_links
end

#account_readability_type ⇒ Object

The type of metric that has been configured for the account (in the platform). This value can be used to lookup the corresponding object with values.



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

def 
  @account_readability_type
end

#automated_readability ⇒ Object

Returns the value of attribute automated_readability.



21
22
23
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 21

def automated_readability
  @automated_readability
end

#coleman_liau ⇒ Object

Returns the value of attribute coleman_liau.



23
24
25
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 23

def coleman_liau
  @coleman_liau
end

#flesch_kincaid_grade_level ⇒ Object

Returns the value of attribute flesch_kincaid_grade_level.



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

def flesch_kincaid_grade_level
  @flesch_kincaid_grade_level
end

#flesch_kincaid_reading_ease ⇒ Object

Returns the value of attribute flesch_kincaid_reading_ease.



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

def flesch_kincaid_reading_ease
  @flesch_kincaid_reading_ease
end

#gunning_fog ⇒ Object

Returns the value of attribute gunning_fog.



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

def gunning_fog
  @gunning_fog
end

#lix ⇒ Object

Returns the value of attribute lix.



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

def lix
  @lix
end

#score ⇒ Object

The readability score for the account configured metric



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

def score
  @score
end

#smog ⇒ Object

Returns the value of attribute smog.



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

def smog
  @smog
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 63

def self.attribute_map
  {
    :'account_readability_type' => :'account_readability_type',
    :'automated_readability' => :'automated_readability',
    :'coleman_liau' => :'coleman_liau',
    :'flesch_kincaid_grade_level' => :'flesch_kincaid_grade_level',
    :'flesch_kincaid_reading_ease' => :'flesch_kincaid_reading_ease',
    :'gunning_fog' => :'gunning_fog',
    :'lix' => :'lix',
    :'score' => :'score',
    :'smog' => :'smog',
    :'_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



225
226
227
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 225

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 84

def self.openapi_types
  {
    :'account_readability_type' => :'String',
    :'automated_readability' => :'AutomatedReadability',
    :'coleman_liau' => :'ColemanLiau',
    :'flesch_kincaid_grade_level' => :'FleschKincaidGradeLevel',
    :'flesch_kincaid_reading_ease' => :'FleschKincaidReadingEase',
    :'gunning_fog' => :'GunningFog',
    :'lix' => :'Lix',
    :'score' => :'Float',
    :'smog' => :'Smog',
    :'_links' => :'Links1'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      automated_readability == o.automated_readability &&
      coleman_liau == o.coleman_liau &&
      flesch_kincaid_grade_level == o.flesch_kincaid_grade_level &&
      flesch_kincaid_reading_ease == o.flesch_kincaid_reading_ease &&
      gunning_fog == o.gunning_fog &&
      lix == o.lix &&
      score == o.score &&
      smog == o.smog &&
      _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



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
289
290
291
292
293
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 256

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 327

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 232

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


212
213
214
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 218

def hash
  [, automated_readability, coleman_liau, flesch_kincaid_grade_level, flesch_kincaid_reading_ease, gunning_fog, lix, score, smog, _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



165
166
167
168
169
170
171
172
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  if @account_readability_type.nil?
    invalid_properties.push('invalid value for "account_readability_type", account_readability_type 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



303
304
305
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 303

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 309

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



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

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



176
177
178
179
180
181
 
# File 'lib/siteimprove_api_client/models/content_check_readability.rb', line 176

def valid?
  return false if @account_readability_type.nil?
   = EnumAttributeValidator.new('String', ["all", "lix", "automated_readability", "coleman_liau", "smog", "gunning_fog", "flesch_kincaid_grade_level", "flesch_kincaid_reading_ease"])
  return false unless .valid?(@account_readability_type)
  true
end