Class: UltracartClient::ScreenRecordingPageView

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScreenRecordingPageView

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
192
193
194
195
196
197
198
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 111

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?(:'domain')
    self.domain = attributes[:'domain']
  end

  if attributes.has_key?(:'events')
    if (value = attributes[:'events']).is_a?(Array)
      self.events = value
    end
  end

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

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

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

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

  if attributes.has_key?(:'params')
    if (value = attributes[:'params']).is_a?(Array)
      self.params = value
    end
  end

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

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

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

  if attributes.has_key?(:'referrer_params')
    if (value = attributes[:'referrer_params']).is_a?(Array)
      self.referrer_params = value
    end
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#domainObject

Returns the value of attribute domain.



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

def domain
  @domain
end

#eventsObject

Returns the value of attribute events.



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

def events
  @events
end

#first_event_timestampObject

First event timestamp



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

def first_event_timestamp
  @first_event_timestamp
end

#http_postObject

Returns the value of attribute http_post.



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

def http_post
  @http_post
end

#last_event_timestampObject

Last event timestamp



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

def last_event_timestamp
  @last_event_timestamp
end

#missing_eventsObject

Returns the value of attribute missing_events.



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

def missing_events
  @missing_events
end

#paramsObject

Returns the value of attribute params.



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

def params
  @params
end

#range_endObject

Returns the value of attribute range_end.



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

def range_end
  @range_end
end

#range_startObject

Returns the value of attribute range_start.



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

def range_start
  @range_start
end

#referrerObject

Returns the value of attribute referrer.



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

def referrer
  @referrer
end

#referrer_paramsObject

Returns the value of attribute referrer_params.



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

def referrer_params
  @referrer_params
end

#referrer_rawObject

Returns the value of attribute referrer_raw.



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

def referrer_raw
  @referrer_raw
end

#screen_recording_page_view_uuidObject

Returns the value of attribute screen_recording_page_view_uuid.



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

def screen_recording_page_view_uuid
  @screen_recording_page_view_uuid
end

#time_on_pageObject

Returns the value of attribute time_on_page.



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

def time_on_page
  @time_on_page
end

#timing_dom_content_loadedObject

Amount of time for DOMContentLoaded event to fire (milliseconds)



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

def timing_dom_content_loaded
  @timing_dom_content_loaded
end

#timing_loadedObject

Amount of time for loaded event to fire (milliseconds)



51
52
53
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 51

def timing_loaded
  @timing_loaded
end

#truncated_eventsObject

Returns the value of attribute truncated_events.



53
54
55
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 53

def truncated_events
  @truncated_events
end

#ucapvObject

Returns the value of attribute ucapv.



55
56
57
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 55

def ucapv
  @ucapv
end

#urlObject

Returns the value of attribute url.



57
58
59
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 57

def url
  @url
end

Class Method Details

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 60

def self.attribute_map
  {
    :'domain' => :'domain',
    :'events' => :'events',
    :'first_event_timestamp' => :'first_event_timestamp',
    :'http_post' => :'http_post',
    :'last_event_timestamp' => :'last_event_timestamp',
    :'missing_events' => :'missing_events',
    :'params' => :'params',
    :'range_end' => :'range_end',
    :'range_start' => :'range_start',
    :'referrer' => :'referrer',
    :'referrer_params' => :'referrer_params',
    :'referrer_raw' => :'referrer_raw',
    :'screen_recording_page_view_uuid' => :'screen_recording_page_view_uuid',
    :'time_on_page' => :'time_on_page',
    :'timing_dom_content_loaded' => :'timing_dom_content_loaded',
    :'timing_loaded' => :'timing_loaded',
    :'truncated_events' => :'truncated_events',
    :'ucapv' => :'ucapv',
    :'url' => :'url'
  }
end

.swagger_typesObject

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 85

def self.swagger_types
  {
    :'domain' => :'String',
    :'events' => :'Array<ScreenRecordingPageViewEvent>',
    :'first_event_timestamp' => :'String',
    :'http_post' => :'BOOLEAN',
    :'last_event_timestamp' => :'String',
    :'missing_events' => :'BOOLEAN',
    :'params' => :'Array<ScreenRecordingPageViewParameter>',
    :'range_end' => :'Integer',
    :'range_start' => :'Integer',
    :'referrer' => :'String',
    :'referrer_params' => :'Array<ScreenRecordingPageViewParameter>',
    :'referrer_raw' => :'String',
    :'screen_recording_page_view_uuid' => :'String',
    :'time_on_page' => :'Integer',
    :'timing_dom_content_loaded' => :'Integer',
    :'timing_loaded' => :'Integer',
    :'truncated_events' => :'BOOLEAN',
    :'ucapv' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      domain == o.domain &&
      events == o.events &&
      first_event_timestamp == o.first_event_timestamp &&
      http_post == o.http_post &&
      last_event_timestamp == o.last_event_timestamp &&
      missing_events == o.missing_events &&
      params == o.params &&
      range_end == o.range_end &&
      range_start == o.range_start &&
      referrer == o.referrer &&
      referrer_params == o.referrer_params &&
      referrer_raw == o.referrer_raw &&
      screen_recording_page_view_uuid == o.screen_recording_page_view_uuid &&
      time_on_page == o.time_on_page &&
      timing_dom_content_loaded == o.timing_dom_content_loaded &&
      timing_loaded == o.timing_loaded &&
      truncated_events == o.truncated_events &&
      ucapv == o.ucapv &&
      url == o.url
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



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

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



341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 341

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



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

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


241
242
243
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 241

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



247
248
249
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 247

def hash
  [domain, events, first_event_timestamp, http_post, last_event_timestamp, missing_events, params, range_end, range_start, referrer, referrer_params, referrer_raw, screen_recording_page_view_uuid, time_on_page, timing_dom_content_loaded, timing_loaded, truncated_events, ucapv, url].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



321
322
323
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 321

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 327

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



315
316
317
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 315

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



209
210
211
# File 'lib/ultracart_api/models/screen_recording_page_view.rb', line 209

def valid?
  true
end