Class: SiteimproveAPIClient::DismissedPageLink

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DismissedPageLink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 119

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

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

  if attributes.key?(:'decision')
    self.decision = attributes[:'decision']
  else
    self.decision = 'forever'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



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

def _siteimprove
  @_siteimprove
end

#comments ⇒ Object

A comment provided by the user when the link was dismissed.



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

def comments
  @comments
end

#decision ⇒ Object

Dismiss for now: the link will not be flagged again unless the HTTP status code changes. Dismiss forever: the link will not be flagged again until someone manually reverses the decision. Ignored: the link will be removed as an exclusion and not longer checked.



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

def decision
  @decision
end

#dismissed_at ⇒ Object

Timestamp for when this link was dismissed.



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

def dismissed_at
  @dismissed_at
end

#first_detected ⇒ Object

Timestamp for when this link was first checked.



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

def first_detected
  @first_detected
end

#http_status ⇒ Object

HTTP status of the dismissed link.



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

def http_status
  @http_status
end

#id ⇒ Object

The ID of the dismissed link.



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

def id
  @id
end

#last_checked ⇒ Object

Timestamp for when this link was last checked.



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

def last_checked
  @last_checked
end

#original_http_status ⇒ Object

HTTP status of the dismissed link at the moment it was dismissed.



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

def original_http_status
  @original_http_status
end

#person_name ⇒ Object

The name of the person creating this decision



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

def person_name
  @person_name
end

#url ⇒ Object

The URL of the dismissed link.



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 73

def self.attribute_map
  {
    :'id' => :'id',
    :'url' => :'url',
    :'comments' => :'comments',
    :'decision' => :'decision',
    :'dismissed_at' => :'dismissed_at',
    :'first_detected' => :'first_detected',
    :'http_status' => :'http_status',
    :'last_checked' => :'last_checked',
    :'original_http_status' => :'original_http_status',
    :'person_name' => :'person_name',
    :'_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



257
258
259
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 257

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 95

def self.openapi_types
  {
    :'id' => :'Integer',
    :'url' => :'String',
    :'comments' => :'String',
    :'decision' => :'String',
    :'dismissed_at' => :'Time',
    :'first_detected' => :'Time',
    :'http_status' => :'Integer',
    :'last_checked' => :'Time',
    :'original_http_status' => :'Integer',
    :'person_name' => :'String',
    :'_siteimprove' => :'Siteimprove1'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      url == o.url &&
      comments == o.comments &&
      decision == o.decision &&
      dismissed_at == o.dismissed_at &&
      first_detected == o.first_detected &&
      http_status == o.http_status &&
      last_checked == o.last_checked &&
      original_http_status == o.original_http_status &&
      person_name == o.person_name &&
      _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



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
321
322
323
324
325
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 288

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 359

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 264

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


244
245
246
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 250

def hash
  [id, url, comments, decision, dismissed_at, first_detected, http_status, last_checked, original_http_status, person_name, _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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 181

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

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

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

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



335
336
337
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 341

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



329
330
331
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 329

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



204
205
206
207
208
209
210
211
212
 
# File 'lib/siteimprove_api_client/models/dismissed_page_link.rb', line 204

def valid?
  return false if @id.nil?
  return false if @decision.nil?
  decision_validator = EnumAttributeValidator.new('String', ["forever", "for_now", "ignored"])
  return false unless decision_validator.valid?(@decision)
  return false if @dismissed_at.nil?
  return false if @last_checked.nil?
  true
end