ultracart_api 4.1.178 → 4.1.179

data/lib/ultracart_api/models/sfvb_recording.rb

@@ -0,0 +1,431 @@
+=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 SfvbRecording
+    attr_accessor :ad_platform
+
+    # Browser name from the user agent.
+    attr_accessor :browser
+
+    # Browser version from the user agent.
+    attr_accessor :browser_version
+
+    # True when the session ended in an order.
+    attr_accessor :converted
+
+    # Device name from the user agent.
+    attr_accessor :device
+
+    # When the session ended, ISO-8601 in UTC.
+    attr_accessor :end_timestamp
+
+    # Country the visitor was in.
+    attr_accessor :geolocation_country
+
+    # State or region the visitor was in.
+    attr_accessor :geolocation_state
+
+    # The browser language.
+    attr_accessor :language_iso_code
+
+    # The order placed during the session, when there was one.
+    attr_accessor :order_id
+
+    # Operating system from the user agent.
+    attr_accessor :os
+
+    # How many pages the visitor viewed.
+    attr_accessor :page_view_count
+
+    # The pages viewed, in order.
+    attr_accessor :page_views
+
+    # The domain that referred the visitor.
+    attr_accessor :referrer_domain
+
+    # The rrweb version that recorded the session.  Replay with the same version.
+    attr_accessor :rrweb_version
+
+    # Identifies the recording.
+    attr_accessor :screen_recording_uuid
+
+    # When the session started, ISO-8601 in UTC.
+    attr_accessor :start_timestamp
+
+    # Seconds the visitor spent on the site.
+    attr_accessor :time_on_site
+
+    # utm_campaign on arrival.
+    attr_accessor :utm_campaign
+
+    # utm_source on arrival.
+    attr_accessor :utm_source
+
+    # Browser window height in pixels.
+    attr_accessor :window_height
+
+    # Browser window width in pixels.
+    attr_accessor :window_width
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ad_platform' => :'ad_platform',
+        :'browser' => :'browser',
+        :'browser_version' => :'browser_version',
+        :'converted' => :'converted',
+        :'device' => :'device',
+        :'end_timestamp' => :'end_timestamp',
+        :'geolocation_country' => :'geolocation_country',
+        :'geolocation_state' => :'geolocation_state',
+        :'language_iso_code' => :'language_iso_code',
+        :'order_id' => :'order_id',
+        :'os' => :'os',
+        :'page_view_count' => :'page_view_count',
+        :'page_views' => :'page_views',
+        :'referrer_domain' => :'referrer_domain',
+        :'rrweb_version' => :'rrweb_version',
+        :'screen_recording_uuid' => :'screen_recording_uuid',
+        :'start_timestamp' => :'start_timestamp',
+        :'time_on_site' => :'time_on_site',
+        :'utm_campaign' => :'utm_campaign',
+        :'utm_source' => :'utm_source',
+        :'window_height' => :'window_height',
+        :'window_width' => :'window_width'
+      }
+    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
+      {
+        :'ad_platform' => :'ScreenRecordingAdPlatform',
+        :'browser' => :'String',
+        :'browser_version' => :'String',
+        :'converted' => :'Boolean',
+        :'device' => :'String',
+        :'end_timestamp' => :'String',
+        :'geolocation_country' => :'String',
+        :'geolocation_state' => :'String',
+        :'language_iso_code' => :'String',
+        :'order_id' => :'String',
+        :'os' => :'String',
+        :'page_view_count' => :'Integer',
+        :'page_views' => :'Array<SfvbRecordingPageView>',
+        :'referrer_domain' => :'String',
+        :'rrweb_version' => :'String',
+        :'screen_recording_uuid' => :'String',
+        :'start_timestamp' => :'String',
+        :'time_on_site' => :'Integer',
+        :'utm_campaign' => :'String',
+        :'utm_source' => :'String',
+        :'window_height' => :'Integer',
+        :'window_width' => :'Integer'
+      }
+    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::SfvbRecording` 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::SfvbRecording`. 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?(:'ad_platform')
+        self.ad_platform = attributes[:'ad_platform']
+      end
+
+      if attributes.key?(:'browser')
+        self.browser = attributes[:'browser']
+      end
+
+      if attributes.key?(:'browser_version')
+        self.browser_version = attributes[:'browser_version']
+      end
+
+      if attributes.key?(:'converted')
+        self.converted = attributes[:'converted']
+      end
+
+      if attributes.key?(:'device')
+        self.device = attributes[:'device']
+      end
+
+      if attributes.key?(:'end_timestamp')
+        self.end_timestamp = attributes[:'end_timestamp']
+      end
+
+      if attributes.key?(:'geolocation_country')
+        self.geolocation_country = attributes[:'geolocation_country']
+      end
+
+      if attributes.key?(:'geolocation_state')
+        self.geolocation_state = attributes[:'geolocation_state']
+      end
+
+      if attributes.key?(:'language_iso_code')
+        self.language_iso_code = attributes[:'language_iso_code']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'os')
+        self.os = attributes[:'os']
+      end
+
+      if attributes.key?(:'page_view_count')
+        self.page_view_count = attributes[:'page_view_count']
+      end
+
+      if attributes.key?(:'page_views')
+        if (value = attributes[:'page_views']).is_a?(Array)
+          self.page_views = value
+        end
+      end
+
+      if attributes.key?(:'referrer_domain')
+        self.referrer_domain = attributes[:'referrer_domain']
+      end
+
+      if attributes.key?(:'rrweb_version')
+        self.rrweb_version = attributes[:'rrweb_version']
+      end
+
+      if attributes.key?(:'screen_recording_uuid')
+        self.screen_recording_uuid = attributes[:'screen_recording_uuid']
+      end
+
+      if attributes.key?(:'start_timestamp')
+        self.start_timestamp = attributes[:'start_timestamp']
+      end
+
+      if attributes.key?(:'time_on_site')
+        self.time_on_site = attributes[:'time_on_site']
+      end
+
+      if attributes.key?(:'utm_campaign')
+        self.utm_campaign = attributes[:'utm_campaign']
+      end
+
+      if attributes.key?(:'utm_source')
+        self.utm_source = attributes[:'utm_source']
+      end
+
+      if attributes.key?(:'window_height')
+        self.window_height = attributes[:'window_height']
+      end
+
+      if attributes.key?(:'window_width')
+        self.window_width = attributes[:'window_width']
+      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 &&
+          ad_platform == o.ad_platform &&
+          browser == o.browser &&
+          browser_version == o.browser_version &&
+          converted == o.converted &&
+          device == o.device &&
+          end_timestamp == o.end_timestamp &&
+          geolocation_country == o.geolocation_country &&
+          geolocation_state == o.geolocation_state &&
+          language_iso_code == o.language_iso_code &&
+          order_id == o.order_id &&
+          os == o.os &&
+          page_view_count == o.page_view_count &&
+          page_views == o.page_views &&
+          referrer_domain == o.referrer_domain &&
+          rrweb_version == o.rrweb_version &&
+          screen_recording_uuid == o.screen_recording_uuid &&
+          start_timestamp == o.start_timestamp &&
+          time_on_site == o.time_on_site &&
+          utm_campaign == o.utm_campaign &&
+          utm_source == o.utm_source &&
+          window_height == o.window_height &&
+          window_width == o.window_width
+    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
+      [ad_platform, browser, browser_version, converted, device, end_timestamp, geolocation_country, geolocation_state, language_iso_code, order_id, os, page_view_count, page_views, referrer_domain, rrweb_version, screen_recording_uuid, start_timestamp, time_on_site, utm_campaign, utm_source, window_height, window_width].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_event.rb

@@ -0,0 +1,252 @@
+=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 SfvbRecordingEvent
+    # The event name, such as rage click, script error, checkout error or add to cart.
+    attr_accessor :name
+
+    # The event's parameters as name and value pairs.  Omitted for input change events, whose values are what the visitor typed.
+    attr_accessor :params
+
+    # A short human readable summary of the event, when the recorder produced one.
+    attr_accessor :sub_text
+
+    # When it happened, ISO-8601 in UTC.  Subtract the page view's first_event_timestamp for the offset into the replay.
+    attr_accessor :timestamp
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'params' => :'params',
+        :'sub_text' => :'sub_text',
+        :'timestamp' => :'timestamp'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'params' => :'Array<SfvbRecordingParameter>',
+        :'sub_text' => :'String',
+        :'timestamp' => :'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::SfvbRecordingEvent` 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::SfvbRecordingEvent`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'params')
+        if (value = attributes[:'params']).is_a?(Array)
+          self.params = value
+        end
+      end
+
+      if attributes.key?(:'sub_text')
+        self.sub_text = attributes[:'sub_text']
+      end
+
+      if attributes.key?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      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 &&
+          name == o.name &&
+          params == o.params &&
+          sub_text == o.sub_text &&
+          timestamp == o.timestamp
+    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
+      [name, params, sub_text, timestamp].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