Class: SiteimproveAPIClient::DocumentWithError

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentWithError

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 114

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

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

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

  if attributes.key?(:'has_text')
    self.has_text = attributes[:'has_text']
  else
    self.has_text = 'no'
  end

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



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

def _links
  @_links
end

#checking_now ⇒ Object

Whether the PDF document is being checked at the moment



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

def checking_now
  @checking_now
end

#errors ⇒ Object

Number of errors in the document



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

def errors
  @errors
end

#has_text ⇒ Object

Whether the document contains text. Alternatively it may be a graphics only document.



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

def has_text
  @has_text
end

#id ⇒ Object

id of the PDF document



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

def id
  @id
end

#is_tagged ⇒ Object

Whether the document is tagged



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

def is_tagged
  @is_tagged
end

#last_modified ⇒ Object

When was the document modified the last time



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

def last_modified
  @last_modified
end

#page_views ⇒ Object

Number of times this page has been viewed



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

def page_views
  @page_views
end

#title ⇒ Object

Title in the PDF document



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

def title
  @title
end

#url ⇒ Object

Url for the PDF document



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 70

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'url' => :'url',
    :'checking_now' => :'checking_now',
    :'errors' => :'errors',
    :'has_text' => :'has_text',
    :'is_tagged' => :'is_tagged',
    :'last_modified' => :'last_modified',
    :'page_views' => :'page_views',
    :'_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



252
253
254
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 91

def self.openapi_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'url' => :'String',
    :'checking_now' => :'Boolean',
    :'errors' => :'Integer',
    :'has_text' => :'String',
    :'is_tagged' => :'Boolean',
    :'last_modified' => :'Time',
    :'page_views' => :'Integer',
    :'_links' => :'Links19'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      url == o.url &&
      checking_now == o.checking_now &&
      errors == o.errors &&
      has_text == o.has_text &&
      is_tagged == o.is_tagged &&
      last_modified == o.last_modified &&
      page_views == o.page_views &&
      _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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 283

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 354

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 259

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


239
240
241
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 245

def hash
  [id, title, url, checking_now, errors, has_text, is_tagged, last_modified, page_views, _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



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/document_with_error.rb', line 172

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

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

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

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

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



330
331
332
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 336

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



324
325
326
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 324

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



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/siteimprove_api_client/models/document_with_error.rb', line 199

def valid?
  return false if @id.nil?
  return false if @checking_now.nil?
  return false if @errors.nil?
  return false if @has_text.nil?
  has_text_validator = EnumAttributeValidator.new('String', ["no", "yes", "unknown"])
  return false unless has_text_validator.valid?(@has_text)
  return false if @is_tagged.nil?
  true
end