Class: UltracartClient::HitSessionStart

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/hit_session_start.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HitSessionStart

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 99

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key

  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'bot')
    self.bot = attributes[:'bot']
  end

  if attributes.has_key?(:'bounce')
    self.bounce = attributes[:'bounce']
  end

  if attributes.has_key?(:'channel')
    self.channel = attributes[:'channel']
  end

  if attributes.has_key?(:'device_switch_detected')
    self.device_switch_detected = attributes[:'device_switch_detected']
  end

  if attributes.has_key?(:'fake_bot')
    self.fake_bot = attributes[:'fake_bot']
  end

  if attributes.has_key?(:'geolocation_country')
    self.geolocation_country = attributes[:'geolocation_country']
  end

  if attributes.has_key?(:'geolocation_latitude')
    self.geolocation_latitude = attributes[:'geolocation_latitude']
  end

  if attributes.has_key?(:'geolocation_longitude')
    self.geolocation_longitude = attributes[:'geolocation_longitude']
  end

  if attributes.has_key?(:'geolocation_province')
    self.geolocation_province = attributes[:'geolocation_province']
  end

  if attributes.has_key?(:'no_cookie_support')
    self.no_cookie_support = attributes[:'no_cookie_support']
  end

  if attributes.has_key?(:'prefetch')
    self.prefetch = attributes[:'prefetch']
  end

  if attributes.has_key?(:'referrer')
    self.referrer = attributes[:'referrer']
  end

  if attributes.has_key?(:'screen_height')
    self.screen_height = attributes[:'screen_height']
  end

  if attributes.has_key?(:'screen_width')
    self.screen_width = attributes[:'screen_width']
  end

  if attributes.has_key?(:'time_on_Site')
    self.time_on_site = attributes[:'time_on_Site']
  end

  if attributes.has_key?(:'user_agent')
    self.user_agent = attributes[:'user_agent']
  end

  if attributes.has_key?(:'user_ip')
    self.user_ip = attributes[:'user_ip']
  end
end

Instance Attribute Details

#bot ⇒ Object

Returns the value of attribute bot.



17
18
19
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 17

def bot
  @bot
end

#bounce ⇒ Object

Returns the value of attribute bounce.



19
20
21
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 19

def bounce
  @bounce
end

#channel ⇒ Object

Returns the value of attribute channel.



21
22
23
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 21

def channel
  @channel
end

#device_switch_detected ⇒ Object

Returns the value of attribute device_switch_detected.



23
24
25
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 23

def device_switch_detected
  @device_switch_detected
end

#fake_bot ⇒ Object

Returns the value of attribute fake_bot.



25
26
27
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 25

def fake_bot
  @fake_bot
end

#geolocation_country ⇒ Object

Returns the value of attribute geolocation_country.



27
28
29
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 27

def geolocation_country
  @geolocation_country
end

#geolocation_latitude ⇒ Object

Returns the value of attribute geolocation_latitude.



29
30
31
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 29

def geolocation_latitude
  @geolocation_latitude
end

#geolocation_longitude ⇒ Object

Returns the value of attribute geolocation_longitude.



31
32
33
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 31

def geolocation_longitude
  @geolocation_longitude
end

#geolocation_province ⇒ Object

Returns the value of attribute geolocation_province.



33
34
35
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 33

def geolocation_province
  @geolocation_province
end

#no_cookie_support ⇒ Object

Returns the value of attribute no_cookie_support.



35
36
37
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 35

def no_cookie_support
  @no_cookie_support
end

#prefetch ⇒ Object

Returns the value of attribute prefetch.



37
38
39
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 37

def prefetch
  @prefetch
end

#referrer ⇒ Object

Returns the value of attribute referrer.



39
40
41
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 39

def referrer
  @referrer
end

#screen_height ⇒ Object

Returns the value of attribute screen_height.



41
42
43
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 41

def screen_height
  @screen_height
end

#screen_width ⇒ Object

Returns the value of attribute screen_width.



43
44
45
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 43

def screen_width
  @screen_width
end

#time_on_site ⇒ Object

Returns the value of attribute time_on_site.



45
46
47
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 45

def time_on_site
  @time_on_site
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.



47
48
49
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 47

def user_agent
  @user_agent
end

#user_ip ⇒ Object

Returns the value of attribute user_ip.



49
50
51
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 49

def user_ip
  @user_ip
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 52

def self.attribute_map
  {
    :'bot' => :'bot',
    :'bounce' => :'bounce',
    :'channel' => :'channel',
    :'device_switch_detected' => :'device_switch_detected',
    :'fake_bot' => :'fake_bot',
    :'geolocation_country' => :'geolocation_country',
    :'geolocation_latitude' => :'geolocation_latitude',
    :'geolocation_longitude' => :'geolocation_longitude',
    :'geolocation_province' => :'geolocation_province',
    :'no_cookie_support' => :'no_cookie_support',
    :'prefetch' => :'prefetch',
    :'referrer' => :'referrer',
    :'screen_height' => :'screen_height',
    :'screen_width' => :'screen_width',
    :'time_on_site' => :'time_on_Site',
    :'user_agent' => :'user_agent',
    :'user_ip' => :'user_ip'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 75

def self.swagger_types
  {
    :'bot' => :'BOOLEAN',
    :'bounce' => :'BOOLEAN',
    :'channel' => :'String',
    :'device_switch_detected' => :'BOOLEAN',
    :'fake_bot' => :'BOOLEAN',
    :'geolocation_country' => :'String',
    :'geolocation_latitude' => :'Float',
    :'geolocation_longitude' => :'Float',
    :'geolocation_province' => :'String',
    :'no_cookie_support' => :'BOOLEAN',
    :'prefetch' => :'BOOLEAN',
    :'referrer' => :'String',
    :'screen_height' => :'Integer',
    :'screen_width' => :'Integer',
    :'time_on_site' => :'Float',
    :'user_agent' => :'String',
    :'user_ip' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bot == o.bot &&
      bounce == o.bounce &&
      channel == o.channel &&
      device_switch_detected == o.device_switch_detected &&
      fake_bot == o.fake_bot &&
      geolocation_country == o.geolocation_country &&
      geolocation_latitude == o.geolocation_latitude &&
      geolocation_longitude == o.geolocation_longitude &&
      geolocation_province == o.geolocation_province &&
      no_cookie_support == o.no_cookie_support &&
      prefetch == o.prefetch &&
      referrer == o.referrer &&
      screen_height == o.screen_height &&
      screen_width == o.screen_width &&
      time_on_site == o.time_on_site &&
      user_agent == o.user_agent &&
      user_ip == o.user_ip
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 247

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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

    temp_model = UltracartClient.const_get(type).new
    temp_model.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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 313

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional

  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


213
214
215
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 219

def hash
  [bot, bounce, channel, device_switch_detected, fake_bot, geolocation_country, geolocation_latitude, geolocation_longitude, geolocation_province, no_cookie_support, prefetch, referrer, screen_height, screen_width, time_on_site, user_agent, user_ip].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



176
177
178
179
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 176

def list_invalid_properties
  invalid_properties = Array.new
  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



293
294
295
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 293

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



299
300
301
302
303
304
305
306
307
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 299

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



287
288
289
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 287

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



183
184
185
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 183

def valid?
  true
end