ultracart_api 4.1.178 → 4.1.179

data/lib/ultracart_api/models/sfvb_recording_events_response.rb

@@ -0,0 +1,250 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbRecordingEventsResponse
+    # The page view's rrweb events as a JSON array in a string, the input an rrweb Replayer takes.  Card number and security code fields are masked by the recorder, but other text the visitor typed can appear in it.
+    attr_accessor :events_json
+
+    # The rrweb version that recorded the events.  Replay with the same version.
+    attr_accessor :rrweb_version
+
+    # The page view these events replay.
+    attr_accessor :screen_recording_page_view_uuid
+
+    # The recording the page view belongs to.
+    attr_accessor :screen_recording_uuid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'events_json' => :'events_json',
+        :'rrweb_version' => :'rrweb_version',
+        :'screen_recording_page_view_uuid' => :'screen_recording_page_view_uuid',
+        :'screen_recording_uuid' => :'screen_recording_uuid'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'events_json' => :'String',
+        :'rrweb_version' => :'String',
+        :'screen_recording_page_view_uuid' => :'String',
+        :'screen_recording_uuid' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbRecordingEventsResponse` 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::SfvbRecordingEventsResponse`. 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?(:'events_json')
+        self.events_json = attributes[:'events_json']
+      end
+
+      if attributes.key?(:'rrweb_version')
+        self.rrweb_version = attributes[:'rrweb_version']
+      end
+
+      if attributes.key?(:'screen_recording_page_view_uuid')
+        self.screen_recording_page_view_uuid = attributes[:'screen_recording_page_view_uuid']
+      end
+
+      if attributes.key?(:'screen_recording_uuid')
+        self.screen_recording_uuid = attributes[:'screen_recording_uuid']
+      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 &&
+          events_json == o.events_json &&
+          rrweb_version == o.rrweb_version &&
+          screen_recording_page_view_uuid == o.screen_recording_page_view_uuid &&
+          screen_recording_uuid == o.screen_recording_uuid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [events_json, rrweb_version, screen_recording_page_view_uuid, screen_recording_uuid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      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
+
+    # 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 :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
+
+    # 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)
+        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
+
+    # 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/sfvb_recording_page_view.rb

@@ -0,0 +1,344 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbRecordingPageView
+    # The host name of the address.
+    attr_accessor :domain
+
+    # Named events on this page view in time order, such as rage clicks and script errors.
+    attr_accessor :events
+
+    # When recording of this page view began, ISO-8601 in UTC.
+    attr_accessor :first_event_timestamp
+
+    # When recording of this page view ended, ISO-8601 in UTC.
+    attr_accessor :last_event_timestamp
+
+    # True when no replay events were stored for this page view.
+    attr_accessor :missing_events
+
+    # The query string parameters on the address.
+    attr_accessor :params
+
+    # The referring address, when there was one.
+    attr_accessor :referrer
+
+    # Identifies this page view when fetching its replay events.
+    attr_accessor :screen_recording_page_view_uuid
+
+    # Seconds the visitor spent on the page.
+    attr_accessor :time_on_page
+
+    # Milliseconds until DOMContentLoaded fired.
+    attr_accessor :timing_dom_content_loaded
+
+    # Milliseconds until the load event fired.
+    attr_accessor :timing_loaded
+
+    # True when the recorder stopped storing events part way through this page view.
+    attr_accessor :truncated_events
+
+    # The address the visitor viewed.
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'domain' => :'domain',
+        :'events' => :'events',
+        :'first_event_timestamp' => :'first_event_timestamp',
+        :'last_event_timestamp' => :'last_event_timestamp',
+        :'missing_events' => :'missing_events',
+        :'params' => :'params',
+        :'referrer' => :'referrer',
+        :'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',
+        :'url' => :'url'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'domain' => :'String',
+        :'events' => :'Array<SfvbRecordingEvent>',
+        :'first_event_timestamp' => :'String',
+        :'last_event_timestamp' => :'String',
+        :'missing_events' => :'Boolean',
+        :'params' => :'Array<SfvbRecordingParameter>',
+        :'referrer' => :'String',
+        :'screen_recording_page_view_uuid' => :'String',
+        :'time_on_page' => :'Integer',
+        :'timing_dom_content_loaded' => :'Integer',
+        :'timing_loaded' => :'Integer',
+        :'truncated_events' => :'Boolean',
+        :'url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbRecordingPageView` 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::SfvbRecordingPageView`. 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?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+      if attributes.key?(:'events')
+        if (value = attributes[:'events']).is_a?(Array)
+          self.events = value
+        end
+      end
+
+      if attributes.key?(:'first_event_timestamp')
+        self.first_event_timestamp = attributes[:'first_event_timestamp']
+      end
+
+      if attributes.key?(:'last_event_timestamp')
+        self.last_event_timestamp = attributes[:'last_event_timestamp']
+      end
+
+      if attributes.key?(:'missing_events')
+        self.missing_events = attributes[:'missing_events']
+      end
+
+      if attributes.key?(:'params')
+        if (value = attributes[:'params']).is_a?(Array)
+          self.params = value
+        end
+      end
+
+      if attributes.key?(:'referrer')
+        self.referrer = attributes[:'referrer']
+      end
+
+      if attributes.key?(:'screen_recording_page_view_uuid')
+        self.screen_recording_page_view_uuid = attributes[:'screen_recording_page_view_uuid']
+      end
+
+      if attributes.key?(:'time_on_page')
+        self.time_on_page = attributes[:'time_on_page']
+      end
+
+      if attributes.key?(:'timing_dom_content_loaded')
+        self.timing_dom_content_loaded = attributes[:'timing_dom_content_loaded']
+      end
+
+      if attributes.key?(:'timing_loaded')
+        self.timing_loaded = attributes[:'timing_loaded']
+      end
+
+      if attributes.key?(:'truncated_events')
+        self.truncated_events = attributes[:'truncated_events']
+      end
+
+      if attributes.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 &&
+          domain == o.domain &&
+          events == o.events &&
+          first_event_timestamp == o.first_event_timestamp &&
+          last_event_timestamp == o.last_event_timestamp &&
+          missing_events == o.missing_events &&
+          params == o.params &&
+          referrer == o.referrer &&
+          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 &&
+          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 [Integer] Hash code
+    def hash
+      [domain, events, first_event_timestamp, last_event_timestamp, missing_events, params, referrer, screen_recording_page_view_uuid, time_on_page, timing_dom_content_loaded, timing_loaded, truncated_events, 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 self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      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
+
+    # 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 :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
+
+    # 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)
+        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
+
+    # 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