Class: SiteimproveAPIClient::PolicyOnAccount

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PolicyOnAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 134

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

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

  if attributes.key?(:'category')
    self.category = attributes[:'category']
  else
    self.category = 'content'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



57
58
59
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 57

def _links
  @_links
end

#all_sites ⇒ Object

True if this policy applies to all sites on your account; false if it only applies to a specific site.



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

def all_sites
  @all_sites
end

#category ⇒ Object

The category of the policy: content, media, documents.



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

def category
  @category
end

#created_by ⇒ Object

The name of the user who created the policy.



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

def created_by
  @created_by
end

#created_date ⇒ Object

The data and time the policy was created.



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

def created_date
  @created_date
end

#edited_by ⇒ Object

The name of the user who last edited the policy.



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

def edited_by
  @edited_by
end

#id ⇒ Object

The ID of the policy.



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

def id
  @id
end

#last_edited ⇒ Object

The data and time the policy was last edited.



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

def last_edited
  @last_edited
end

#matches ⇒ Object

The number of matches for this policy on all sites.



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

def matches
  @matches
end

#name ⇒ Object

The name of the policy.



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

def name
  @name
end

#note ⇒ Object

Explain the policy and what actions editors should take (recommended).



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

def note
  @note
end

#pending_execution ⇒ Object

True if the policy is in the process of being evaluated, but that has not completed yet.



49
50
51
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 49

def pending_execution
  @pending_execution
end

#priority ⇒ Object

The priority of the policy.



52
53
54
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 52

def priority
  @priority
end

#sites ⇒ Object

The number of sites this policy is active on.



55
56
57
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 55

def sites
  @sites
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



102
103
104
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 102

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'all_sites' => :'all_sites',
    :'category' => :'category',
    :'created_by' => :'created_by',
    :'created_date' => :'created_date',
    :'edited_by' => :'edited_by',
    :'last_edited' => :'last_edited',
    :'matches' => :'matches',
    :'note' => :'note',
    :'pending_execution' => :'pending_execution',
    :'priority' => :'priority',
    :'sites' => :'sites',
    :'_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



321
322
323
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 321

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 107

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'all_sites' => :'Boolean',
    :'category' => :'String',
    :'created_by' => :'String',
    :'created_date' => :'Time',
    :'edited_by' => :'String',
    :'last_edited' => :'Time',
    :'matches' => :'Integer',
    :'note' => :'String',
    :'pending_execution' => :'Boolean',
    :'priority' => :'String',
    :'sites' => :'Integer',
    :'_links' => :'Links12'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      all_sites == o.all_sites &&
      category == o.category &&
      created_by == o.created_by &&
      created_date == o.created_date &&
      edited_by == o.edited_by &&
      last_edited == o.last_edited &&
      matches == o.matches &&
      note == o.note &&
      pending_execution == o.pending_execution &&
      priority == o.priority &&
      sites == o.sites &&
      _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



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
382
383
384
385
386
387
388
389
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 352

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 423

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 328

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


308
309
310
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



314
315
316
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 314

def hash
  [id, name, all_sites, category, created_by, created_date, edited_by, last_edited, matches, note, pending_execution, priority, sites, _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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
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/policy_on_account.rb', line 210

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

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

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

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

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

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

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

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



399
400
401
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 399

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 405

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



393
394
395
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 393

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/siteimprove_api_client/models/policy_on_account.rb', line 249

def valid?
  return false if @id.nil?
  return false if @all_sites.nil?
  return false if @category.nil?
  category_validator = EnumAttributeValidator.new('String', ["content", "media", "documents"])
  return false unless category_validator.valid?(@category)
  return false if @created_date.nil?
  return false if @matches.nil?
  return false if @pending_execution.nil?
  return false if @priority.nil?
  priority_validator = EnumAttributeValidator.new('String', ["none", "low", "medium", "high"])
  return false unless priority_validator.valid?(@priority)
  return false if @sites.nil?
  true
end