Class: SiteimproveAPIClient::ExternalSearchTermPage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalSearchTermPage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 86

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

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

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



39
40
41
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 39

def _links
  @_links
end

#_siteimprove ⇒ Object

Returns the value of attribute _siteimprove.



41
42
43
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 41

def _siteimprove
  @_siteimprove
end

#bounce_rate ⇒ Object

Bounce rate is an indication of how many visitors only perform a single page view.



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

def bounce_rate
  @bounce_rate
end

#cms_url ⇒ Object

Url for the cms entry for editing the page.



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

def cms_url
  @cms_url
end

#has_integration ⇒ Object

True if the page has integration with Quality Assurance, false if not.



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

def has_integration
  @has_integration
end

#id ⇒ Object

Id of page.



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

def id
  @id
end

#title ⇒ Object

Title of the page



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

def title
  @title
end

#url ⇒ Object

URL for the live version of the page.



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

def url
  @url
end

#visits_of_parent ⇒ Object

Number of visits registered (within the parent item).



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

def visits_of_parent
  @visits_of_parent
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'url' => :'url',
    :'bounce_rate' => :'bounce_rate',
    :'cms_url' => :'cms_url',
    :'has_integration' => :'has_integration',
    :'visits_of_parent' => :'visits_of_parent',
    :'_links' => :'_links',
    :'_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



190
191
192
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 190

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'url' => :'String',
    :'bounce_rate' => :'Float',
    :'cms_url' => :'String',
    :'has_integration' => :'Boolean',
    :'visits_of_parent' => :'Integer',
    :'_links' => :'Links22',
    :'_siteimprove' => :'Siteimprove'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      url == o.url &&
      bounce_rate == o.bounce_rate &&
      cms_url == o.cms_url &&
      has_integration == o.has_integration &&
      visits_of_parent == o.visits_of_parent &&
      _links == o._links &&
      _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



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
256
257
258
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 221

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 292

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 197

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


177
178
179
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



183
184
185
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 183

def hash
  [id, title, url, bounce_rate, cms_url, has_integration, visits_of_parent, _links, _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



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 138

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

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



268
269
270
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 268

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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 274

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



262
263
264
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 262

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



153
154
155
156
157
 
# File 'lib/siteimprove_api_client/models/external_search_term_page.rb', line 153

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