ultracart_api 4.1.170 → 4.1.172

data/lib/ultracart_api/models/sfvb_upsell_stats.rb

@@ -0,0 +1,400 @@
+=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 SfvbUpsellStats
+    # Times the shopper left while the offer was showing.
+    attr_accessor :abandons
+
+    # Profit per view after refunds.
+    attr_accessor :average_visitor_net_profit
+
+    # Revenue per view after refunds.
+    attr_accessor :average_visitor_net_revenue
+
+    # Profit per view.
+    attr_accessor :average_visitor_profit
+
+    # Revenue per view.
+    attr_accessor :average_visitor_revenue
+
+    # Transactions divided by views, as a percentage.
+    attr_accessor :conversion_rate
+
+    # Times the offer was declined.
+    attr_accessor :declines
+
+    # Profit per transaction after refunds.
+    attr_accessor :per_sale_net_profit
+
+    # Revenue per transaction after refunds.
+    attr_accessor :per_sale_net_revenue
+
+    # Profit per transaction.
+    attr_accessor :per_sale_profit
+
+    # Revenue per transaction.
+    attr_accessor :per_sale_revenue
+
+    # Profit from accepted offers.
+    attr_accessor :profit
+
+    # Profit later refunded.
+    attr_accessor :refunded_profit
+
+    # Quantity later refunded.
+    attr_accessor :refunded_quantity
+
+    # Revenue later refunded.
+    attr_accessor :refunded_revenue
+
+    # Revenue from accepted offers.
+    attr_accessor :revenue
+
+    # On a path variation only.  Distinct visitors shown any upsell on this storefront in the window, the denominator for comparing variations.
+    attr_accessor :total_visitors_across_all_paths
+
+    # Distinct sessions that accepted the offer and were charged successfully.
+    attr_accessor :transactions
+
+    # Distinct sessions that were shown the offer.
+    attr_accessor :views
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'abandons' => :'abandons',
+        :'average_visitor_net_profit' => :'average_visitor_net_profit',
+        :'average_visitor_net_revenue' => :'average_visitor_net_revenue',
+        :'average_visitor_profit' => :'average_visitor_profit',
+        :'average_visitor_revenue' => :'average_visitor_revenue',
+        :'conversion_rate' => :'conversion_rate',
+        :'declines' => :'declines',
+        :'per_sale_net_profit' => :'per_sale_net_profit',
+        :'per_sale_net_revenue' => :'per_sale_net_revenue',
+        :'per_sale_profit' => :'per_sale_profit',
+        :'per_sale_revenue' => :'per_sale_revenue',
+        :'profit' => :'profit',
+        :'refunded_profit' => :'refunded_profit',
+        :'refunded_quantity' => :'refunded_quantity',
+        :'refunded_revenue' => :'refunded_revenue',
+        :'revenue' => :'revenue',
+        :'total_visitors_across_all_paths' => :'total_visitors_across_all_paths',
+        :'transactions' => :'transactions',
+        :'views' => :'views'
+      }
+    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
+      {
+        :'abandons' => :'Integer',
+        :'average_visitor_net_profit' => :'Float',
+        :'average_visitor_net_revenue' => :'Float',
+        :'average_visitor_profit' => :'Float',
+        :'average_visitor_revenue' => :'Float',
+        :'conversion_rate' => :'Float',
+        :'declines' => :'Integer',
+        :'per_sale_net_profit' => :'Float',
+        :'per_sale_net_revenue' => :'Float',
+        :'per_sale_profit' => :'Float',
+        :'per_sale_revenue' => :'Float',
+        :'profit' => :'Float',
+        :'refunded_profit' => :'Float',
+        :'refunded_quantity' => :'Integer',
+        :'refunded_revenue' => :'Float',
+        :'revenue' => :'Float',
+        :'total_visitors_across_all_paths' => :'Integer',
+        :'transactions' => :'Integer',
+        :'views' => :'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::SfvbUpsellStats` 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::SfvbUpsellStats`. 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?(:'abandons')
+        self.abandons = attributes[:'abandons']
+      end
+
+      if attributes.key?(:'average_visitor_net_profit')
+        self.average_visitor_net_profit = attributes[:'average_visitor_net_profit']
+      end
+
+      if attributes.key?(:'average_visitor_net_revenue')
+        self.average_visitor_net_revenue = attributes[:'average_visitor_net_revenue']
+      end
+
+      if attributes.key?(:'average_visitor_profit')
+        self.average_visitor_profit = attributes[:'average_visitor_profit']
+      end
+
+      if attributes.key?(:'average_visitor_revenue')
+        self.average_visitor_revenue = attributes[:'average_visitor_revenue']
+      end
+
+      if attributes.key?(:'conversion_rate')
+        self.conversion_rate = attributes[:'conversion_rate']
+      end
+
+      if attributes.key?(:'declines')
+        self.declines = attributes[:'declines']
+      end
+
+      if attributes.key?(:'per_sale_net_profit')
+        self.per_sale_net_profit = attributes[:'per_sale_net_profit']
+      end
+
+      if attributes.key?(:'per_sale_net_revenue')
+        self.per_sale_net_revenue = attributes[:'per_sale_net_revenue']
+      end
+
+      if attributes.key?(:'per_sale_profit')
+        self.per_sale_profit = attributes[:'per_sale_profit']
+      end
+
+      if attributes.key?(:'per_sale_revenue')
+        self.per_sale_revenue = attributes[:'per_sale_revenue']
+      end
+
+      if attributes.key?(:'profit')
+        self.profit = attributes[:'profit']
+      end
+
+      if attributes.key?(:'refunded_profit')
+        self.refunded_profit = attributes[:'refunded_profit']
+      end
+
+      if attributes.key?(:'refunded_quantity')
+        self.refunded_quantity = attributes[:'refunded_quantity']
+      end
+
+      if attributes.key?(:'refunded_revenue')
+        self.refunded_revenue = attributes[:'refunded_revenue']
+      end
+
+      if attributes.key?(:'revenue')
+        self.revenue = attributes[:'revenue']
+      end
+
+      if attributes.key?(:'total_visitors_across_all_paths')
+        self.total_visitors_across_all_paths = attributes[:'total_visitors_across_all_paths']
+      end
+
+      if attributes.key?(:'transactions')
+        self.transactions = attributes[:'transactions']
+      end
+
+      if attributes.key?(:'views')
+        self.views = attributes[:'views']
+      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 &&
+          abandons == o.abandons &&
+          average_visitor_net_profit == o.average_visitor_net_profit &&
+          average_visitor_net_revenue == o.average_visitor_net_revenue &&
+          average_visitor_profit == o.average_visitor_profit &&
+          average_visitor_revenue == o.average_visitor_revenue &&
+          conversion_rate == o.conversion_rate &&
+          declines == o.declines &&
+          per_sale_net_profit == o.per_sale_net_profit &&
+          per_sale_net_revenue == o.per_sale_net_revenue &&
+          per_sale_profit == o.per_sale_profit &&
+          per_sale_revenue == o.per_sale_revenue &&
+          profit == o.profit &&
+          refunded_profit == o.refunded_profit &&
+          refunded_quantity == o.refunded_quantity &&
+          refunded_revenue == o.refunded_revenue &&
+          revenue == o.revenue &&
+          total_visitors_across_all_paths == o.total_visitors_across_all_paths &&
+          transactions == o.transactions &&
+          views == o.views
+    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
+      [abandons, average_visitor_net_profit, average_visitor_net_revenue, average_visitor_profit, average_visitor_revenue, conversion_rate, declines, per_sale_net_profit, per_sale_net_revenue, per_sale_profit, per_sale_revenue, profit, refunded_profit, refunded_quantity, refunded_revenue, revenue, total_visitors_across_all_paths, transactions, views].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_upsell_step.rb

@@ -0,0 +1,241 @@
+=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 SfvbUpsellStep
+    # An experiment step, splitting shoppers between these offers.  Set this or offer, not both.
+    attr_accessor :experiment_offers
+
+    attr_accessor :offer
+
+    # Read only.  offer or experiment, from whichever of the two below is set.
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'experiment_offers' => :'experiment_offers',
+        :'offer' => :'offer',
+        :'type' => :'type'
+      }
+    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
+      {
+        :'experiment_offers' => :'Array<SfvbUpsellStepOffer>',
+        :'offer' => :'SfvbUpsellStepOffer',
+        :'type' => :'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::SfvbUpsellStep` 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::SfvbUpsellStep`. 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?(:'experiment_offers')
+        if (value = attributes[:'experiment_offers']).is_a?(Array)
+          self.experiment_offers = value
+        end
+      end
+
+      if attributes.key?(:'offer')
+        self.offer = attributes[:'offer']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 &&
+          experiment_offers == o.experiment_offers &&
+          offer == o.offer &&
+          type == o.type
+    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
+      [experiment_offers, offer, type].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