ultracart_api 3.1.17 → 3.1.41

data/lib/ultracart_api/models/screen_recording_heatmap_url.rb

@@ -0,0 +1,222 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ScreenRecordingHeatmapUrl
+    attr_accessor :histogram_data
+
+    attr_accessor :histogram_interval
+
+    attr_accessor :histogram_start_dts
+
+    attr_accessor :session_count
+
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'histogram_data' => :'histogram_data',
+        :'histogram_interval' => :'histogram_interval',
+        :'histogram_start_dts' => :'histogram_start_dts',
+        :'session_count' => :'session_count',
+        :'url' => :'url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'histogram_data' => :'Array<Integer>',
+        :'histogram_interval' => :'String',
+        :'histogram_start_dts' => :'String',
+        :'session_count' => :'Integer',
+        :'url' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'histogram_data')
+        if (value = attributes[:'histogram_data']).is_a?(Array)
+          self.histogram_data = value
+        end
+      end
+
+      if attributes.has_key?(:'histogram_interval')
+        self.histogram_interval = attributes[:'histogram_interval']
+      end
+
+      if attributes.has_key?(:'histogram_start_dts')
+        self.histogram_start_dts = attributes[:'histogram_start_dts']
+      end
+
+      if attributes.has_key?(:'session_count')
+        self.session_count = attributes[:'session_count']
+      end
+
+      if attributes.has_key?(:'url')
+        self.url = attributes[:'url']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          histogram_data == o.histogram_data &&
+          histogram_interval == o.histogram_interval &&
+          histogram_start_dts == o.histogram_start_dts &&
+          session_count == o.session_count &&
+          url == o.url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [histogram_data, histogram_interval, histogram_start_dts, session_count, url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+end

data/lib/ultracart_api/models/screen_recording_page_view.rb

@@ -14,6 +14,8 @@ require 'date'
 
 module UltracartClient
   class ScreenRecordingPageView
+    attr_accessor :domain
+
     attr_accessor :events
 
     # First event timestamp
@@ -42,6 +44,12 @@ module UltracartClient
 
     attr_accessor :time_on_page
 
+    # Amount of time for DOMContentLoaded event to fire (milliseconds)
+    attr_accessor :timing_dom_content_loaded
+
+    # Amount of time for loaded event to fire (milliseconds)
+    attr_accessor :timing_loaded
+
     attr_accessor :truncated_events
 
     attr_accessor :ucapv
@@ -51,6 +59,7 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'domain' => :'domain',
         :'events' => :'events',
         :'first_event_timestamp' => :'first_event_timestamp',
         :'http_post' => :'http_post',
@@ -64,6 +73,8 @@ module UltracartClient
         :'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'
@@ -73,6 +84,7 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'domain' => :'String',
         :'events' => :'Array<ScreenRecordingPageViewEvent>',
         :'first_event_timestamp' => :'String',
         :'http_post' => :'BOOLEAN',
@@ -86,6 +98,8 @@ module UltracartClient
         :'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'
@@ -100,6 +114,10 @@ module UltracartClient
       # 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
@@ -158,6 +176,14 @@ module UltracartClient
         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
@@ -189,6 +215,7 @@ module UltracartClient
     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 &&
@@ -202,6 +229,8 @@ module UltracartClient
           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
@@ -216,7 +245,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [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, truncated_events, ucapv, url].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
 
     # Builds the object from hash

data/lib/ultracart_api/models/screen_recording_page_view_event.rb

@@ -18,6 +18,8 @@ module UltracartClient
 
     attr_accessor :params
 
+    attr_accessor :prior_page_view
+
     # Timestamp of the event
     attr_accessor :timestamp
 
@@ -28,6 +30,7 @@ module UltracartClient
       {
         :'name' => :'name',
         :'params' => :'params',
+        :'prior_page_view' => :'prior_page_view',
         :'timestamp' => :'timestamp',
         :'ts' => :'ts'
       }
@@ -38,6 +41,7 @@ module UltracartClient
       {
         :'name' => :'String',
         :'params' => :'Array<ScreenRecordingPageViewEventParameter>',
+        :'prior_page_view' => :'BOOLEAN',
         :'timestamp' => :'String',
         :'ts' => :'Integer'
       }
@@ -61,6 +65,10 @@ module UltracartClient
         end
       end
 
+      if attributes.has_key?(:'prior_page_view')
+        self.prior_page_view = attributes[:'prior_page_view']
+      end
+
       if attributes.has_key?(:'timestamp')
         self.timestamp = attributes[:'timestamp']
       end
@@ -90,6 +98,7 @@ module UltracartClient
       self.class == o.class &&
           name == o.name &&
           params == o.params &&
+          prior_page_view == o.prior_page_view &&
           timestamp == o.timestamp &&
           ts == o.ts
     end
@@ -103,7 +112,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, params, timestamp, ts].hash
+      [name, params, prior_page_view, timestamp, ts].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/screen_recording_query_response.rb

@@ -20,6 +20,12 @@ module UltracartClient
 
     attr_accessor :filter_values
 
+    attr_accessor :histogram_data
+
+    attr_accessor :histogram_interval
+
+    attr_accessor :histogram_start_dts
+
     attr_accessor :metadata
 
     attr_accessor :screen_recordings
@@ -35,6 +41,9 @@ module UltracartClient
         :'error' => :'error',
         :'filter' => :'filter',
         :'filter_values' => :'filter_values',
+        :'histogram_data' => :'histogram_data',
+        :'histogram_interval' => :'histogram_interval',
+        :'histogram_start_dts' => :'histogram_start_dts',
         :'metadata' => :'metadata',
         :'screen_recordings' => :'screen_recordings',
         :'success' => :'success',
@@ -48,6 +57,9 @@ module UltracartClient
         :'error' => :'Error',
         :'filter' => :'ScreenRecordingFilter',
         :'filter_values' => :'ScreenRecordingFilterValues',
+        :'histogram_data' => :'Array<Integer>',
+        :'histogram_interval' => :'String',
+        :'histogram_start_dts' => :'String',
         :'metadata' => :'ResponseMetadata',
         :'screen_recordings' => :'Array<ScreenRecording>',
         :'success' => :'BOOLEAN',
@@ -75,6 +87,20 @@ module UltracartClient
         self.filter_values = attributes[:'filter_values']
       end
 
+      if attributes.has_key?(:'histogram_data')
+        if (value = attributes[:'histogram_data']).is_a?(Array)
+          self.histogram_data = value
+        end
+      end
+
+      if attributes.has_key?(:'histogram_interval')
+        self.histogram_interval = attributes[:'histogram_interval']
+      end
+
+      if attributes.has_key?(:'histogram_start_dts')
+        self.histogram_start_dts = attributes[:'histogram_start_dts']
+      end
+
       if attributes.has_key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
@@ -115,6 +141,9 @@ module UltracartClient
           error == o.error &&
           filter == o.filter &&
           filter_values == o.filter_values &&
+          histogram_data == o.histogram_data &&
+          histogram_interval == o.histogram_interval &&
+          histogram_start_dts == o.histogram_start_dts &&
           metadata == o.metadata &&
           screen_recordings == o.screen_recordings &&
           success == o.success &&
@@ -130,7 +159,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [error, filter, filter_values, metadata, screen_recordings, success, warning].hash
+      [error, filter, filter_values, histogram_data, histogram_interval, histogram_start_dts, metadata, screen_recordings, success, warning].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/screen_recording_segment.rb

@@ -20,6 +20,12 @@ module UltracartClient
 
     attr_accessor :filter
 
+    attr_accessor :histogram_data
+
+    attr_accessor :histogram_interval
+
+    attr_accessor :histogram_start_dts
+
     attr_accessor :name
 
     attr_accessor :screen_recording_segment_oid
@@ -34,6 +40,9 @@ module UltracartClient
         :'create_dts' => :'create_dts',
         :'description' => :'description',
         :'filter' => :'filter',
+        :'histogram_data' => :'histogram_data',
+        :'histogram_interval' => :'histogram_interval',
+        :'histogram_start_dts' => :'histogram_start_dts',
         :'name' => :'name',
         :'screen_recording_segment_oid' => :'screen_recording_segment_oid',
         :'session_count' => :'session_count',
@@ -47,6 +56,9 @@ module UltracartClient
         :'create_dts' => :'String',
         :'description' => :'String',
         :'filter' => :'ScreenRecordingFilter',
+        :'histogram_data' => :'Array<Integer>',
+        :'histogram_interval' => :'String',
+        :'histogram_start_dts' => :'String',
         :'name' => :'String',
         :'screen_recording_segment_oid' => :'Integer',
         :'session_count' => :'Integer',
@@ -74,6 +86,20 @@ module UltracartClient
         self.filter = attributes[:'filter']
       end
 
+      if attributes.has_key?(:'histogram_data')
+        if (value = attributes[:'histogram_data']).is_a?(Array)
+          self.histogram_data = value
+        end
+      end
+
+      if attributes.has_key?(:'histogram_interval')
+        self.histogram_interval = attributes[:'histogram_interval']
+      end
+
+      if attributes.has_key?(:'histogram_start_dts')
+        self.histogram_start_dts = attributes[:'histogram_start_dts']
+      end
+
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
@@ -112,6 +138,9 @@ module UltracartClient
           create_dts == o.create_dts &&
           description == o.description &&
           filter == o.filter &&
+          histogram_data == o.histogram_data &&
+          histogram_interval == o.histogram_interval &&
+          histogram_start_dts == o.histogram_start_dts &&
           name == o.name &&
           screen_recording_segment_oid == o.screen_recording_segment_oid &&
           session_count == o.session_count &&
@@ -127,7 +156,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [create_dts, description, filter, name, screen_recording_segment_oid, session_count, session_count_last_update_dts].hash
+      [create_dts, description, filter, histogram_data, histogram_interval, histogram_start_dts, name, screen_recording_segment_oid, session_count, session_count_last_update_dts].hash
     end
 
     # Builds the object from hash