Class: SiteimproveAPIClient::SeoGroupOverviewDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SeoGroupOverviewDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
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
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 83

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

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

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

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

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

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

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

Instance Attribute Details

#errors ⇒ Object

Number of "Errors" in this group.



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

def errors
  @errors
end

#group_name ⇒ Object

Name of group.



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

def group_name
  @group_name
end

#group_users ⇒ Object

Number of users with access to this group.



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

def group_users
  @group_users
end

#id ⇒ Object

Id of group.



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

def id
  @id
end

#needs_review ⇒ Object

Number of "Needs review" in this group.



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

def needs_review
  @needs_review
end

#pages ⇒ Object

Number of pages in this group.



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

def pages
  @pages
end

#searchable_pages ⇒ Object

Number of searchable pages in this group.



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

def searchable_pages
  @searchable_pages
end

#warnings ⇒ Object

Number of "Warnings" in this group.



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

def warnings
  @warnings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 43

def self.attribute_map
  {
    :'id' => :'id',
    :'errors' => :'errors',
    :'group_name' => :'group_name',
    :'group_users' => :'group_users',
    :'needs_review' => :'needs_review',
    :'pages' => :'pages',
    :'searchable_pages' => :'searchable_pages',
    :'warnings' => :'warnings'
  }
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



187
188
189
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 187

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 62

def self.openapi_types
  {
    :'id' => :'Integer',
    :'errors' => :'Integer',
    :'group_name' => :'String',
    :'group_users' => :'Integer',
    :'needs_review' => :'Integer',
    :'pages' => :'Integer',
    :'searchable_pages' => :'Integer',
    :'warnings' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      errors == o.errors &&
      group_name == o.group_name &&
      group_users == o.group_users &&
      needs_review == o.needs_review &&
      pages == o.pages &&
      searchable_pages == o.searchable_pages &&
      warnings == o.warnings
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



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
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 218

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 289

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 194

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


174
175
176
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 180

def hash
  [id, errors, group_name, group_users, needs_review, pages, searchable_pages, warnings].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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 131

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

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

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



265
266
267
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 265

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 271

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



259
260
261
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 259

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



150
151
152
153
154
155
 
# File 'lib/siteimprove_api_client/models/seo_group_overview_details.rb', line 150

def valid?
  return false if @id.nil?
  return false if @group_users.nil?
  return false if @pages.nil?
  true
end