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



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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 111

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bot ⇒ Object

Returns the value of attribute bot.



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

def bot
  @bot
end

#bounce ⇒ Object

Returns the value of attribute bounce.



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

def bounce
  @bounce
end

#channel ⇒ Object

Returns the value of attribute channel.



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

def channel
  @channel
end

#device_switch_detected ⇒ Object

Returns the value of attribute device_switch_detected.



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

def device_switch_detected
  @device_switch_detected
end

#fake_bot ⇒ Object

Returns the value of attribute fake_bot.



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

def fake_bot
  @fake_bot
end

#geolocation_country ⇒ Object

Returns the value of attribute geolocation_country.



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

def geolocation_country
  @geolocation_country
end

#geolocation_latitude ⇒ Object

Returns the value of attribute geolocation_latitude.



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

def geolocation_latitude
  @geolocation_latitude
end

#geolocation_longitude ⇒ Object

Returns the value of attribute geolocation_longitude.



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

def geolocation_longitude
  @geolocation_longitude
end

#geolocation_province ⇒ Object

Returns the value of attribute geolocation_province.



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

def geolocation_province
  @geolocation_province
end

#no_cookie_support ⇒ Object

Returns the value of attribute no_cookie_support.



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

def no_cookie_support
  @no_cookie_support
end

#prefetch ⇒ Object

Returns the value of attribute prefetch.



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

def prefetch
  @prefetch
end

#referrer ⇒ Object

Returns the value of attribute referrer.



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

def referrer
  @referrer
end

#screen_height ⇒ Object

Returns the value of attribute screen_height.



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

def screen_height
  @screen_height
end

#screen_width ⇒ Object

Returns the value of attribute screen_width.



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

def screen_width
  @screen_width
end

#time_on_site ⇒ Object

Returns the value of attribute time_on_site.



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

def time_on_site
  @time_on_site
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.



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

def user_agent
  @user_agent
end

#user_ip ⇒ Object

Returns the value of attribute user_ip.



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

def user_ip
  @user_ip
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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



245
246
247
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 245

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 208

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



276
277
278
279
280
281
282
283
284
285
286
287
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
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 276

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 = UltracartClient.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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 347

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 252

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


232
233
234
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



238
239
240
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 238

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



195
196
197
198
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 195

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



323
324
325
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 329

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



317
318
319
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 317

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



202
203
204
 
# File 'lib/ultracart_api/models/hit_session_start.rb', line 202

def valid?
  true
end