ultracart_api 4.1.222 → 4.1.224

data/lib/ultracart_api/models/sfvb_smart_attribution_platform.rb

@@ -0,0 +1,300 @@
+=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 SfvbSmartAttributionPlatform
+    # This platform's assist credit, 0 to 1.  Used only when platform_type_override is true.
+    attr_accessor :assist_percent
+
+    # This platform's closer credit, 0 to 1.  Used only when platform_type_override is true.
+    attr_accessor :closer_percent
+
+    # True when the platform also reports auto order rebills.  On a write, when left out, true for paid and owned and false for the affiliate types.
+    attr_accessor :fire_on_rebill
+
+    # The integration's id, such as an affiliate network pixel's oid.  Null for a platform matched by name.  On a write it must be an id from platforms or available_platforms.
+    attr_accessor :integration_id
+
+    # The platform, as Smart Attribution names it, up to 50 characters.
+    attr_accessor :integration_name
+
+    # The credit this platform reports for an order it took no part in, 0 to 1.  0 when left out.
+    attr_accessor :non_participant_percent
+
+    # This platform's originator credit, 0 to 1.  Used only when platform_type_override is true.
+    attr_accessor :originator_percent
+
+    # paid, owned, external affiliate, affiliate network pixel, or excluded.
+    attr_accessor :platform_type
+
+    # True when this platform uses its own originator, assist and closer split instead of the global one.  On a write, when left out, true if all three of its percentages are sent.
+    attr_accessor :platform_type_override
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'assist_percent' => :'assist_percent',
+        :'closer_percent' => :'closer_percent',
+        :'fire_on_rebill' => :'fire_on_rebill',
+        :'integration_id' => :'integration_id',
+        :'integration_name' => :'integration_name',
+        :'non_participant_percent' => :'non_participant_percent',
+        :'originator_percent' => :'originator_percent',
+        :'platform_type' => :'platform_type',
+        :'platform_type_override' => :'platform_type_override'
+      }
+    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
+      {
+        :'assist_percent' => :'Float',
+        :'closer_percent' => :'Float',
+        :'fire_on_rebill' => :'Boolean',
+        :'integration_id' => :'Integer',
+        :'integration_name' => :'String',
+        :'non_participant_percent' => :'Float',
+        :'originator_percent' => :'Float',
+        :'platform_type' => :'String',
+        :'platform_type_override' => :'Boolean'
+      }
+    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::SfvbSmartAttributionPlatform` 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::SfvbSmartAttributionPlatform`. 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?(:'assist_percent')
+        self.assist_percent = attributes[:'assist_percent']
+      end
+
+      if attributes.key?(:'closer_percent')
+        self.closer_percent = attributes[:'closer_percent']
+      end
+
+      if attributes.key?(:'fire_on_rebill')
+        self.fire_on_rebill = attributes[:'fire_on_rebill']
+      end
+
+      if attributes.key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      end
+
+      if attributes.key?(:'integration_name')
+        self.integration_name = attributes[:'integration_name']
+      end
+
+      if attributes.key?(:'non_participant_percent')
+        self.non_participant_percent = attributes[:'non_participant_percent']
+      end
+
+      if attributes.key?(:'originator_percent')
+        self.originator_percent = attributes[:'originator_percent']
+      end
+
+      if attributes.key?(:'platform_type')
+        self.platform_type = attributes[:'platform_type']
+      end
+
+      if attributes.key?(:'platform_type_override')
+        self.platform_type_override = attributes[:'platform_type_override']
+      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 &&
+          assist_percent == o.assist_percent &&
+          closer_percent == o.closer_percent &&
+          fire_on_rebill == o.fire_on_rebill &&
+          integration_id == o.integration_id &&
+          integration_name == o.integration_name &&
+          non_participant_percent == o.non_participant_percent &&
+          originator_percent == o.originator_percent &&
+          platform_type == o.platform_type &&
+          platform_type_override == o.platform_type_override
+    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
+      [assist_percent, closer_percent, fire_on_rebill, integration_id, integration_name, non_participant_percent, originator_percent, platform_type, platform_type_override].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_smart_attribution_request.rb

@@ -0,0 +1,282 @@
+=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 SfvbSmartAttributionRequest
+    # 0 to 1, at most 4 decimals.
+    attr_accessor :assist_percent
+
+    # position_based, linear, time_decay or custom.
+    attr_accessor :attribution_model
+
+    # 0 to 1, at most 4 decimals.
+    attr_accessor :closer_percent
+
+    # 7 to 365.
+    attr_accessor :lookback_days
+
+    # disabled, report_only or active.  Making it active, or any change while it is active, needs an approval.
+    attr_accessor :mode
+
+    # 0 to 1, at most 4 decimals.  The three global percentages must total exactly 1, so send all three to change the split.
+    attr_accessor :originator_percent
+
+    # When sent, replaces the whole platform list.  Up to 100, each name and id once.  Left out, the list is unchanged.
+    attr_accessor :platforms
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'assist_percent' => :'assist_percent',
+        :'attribution_model' => :'attribution_model',
+        :'closer_percent' => :'closer_percent',
+        :'lookback_days' => :'lookback_days',
+        :'mode' => :'mode',
+        :'originator_percent' => :'originator_percent',
+        :'platforms' => :'platforms'
+      }
+    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
+      {
+        :'assist_percent' => :'Float',
+        :'attribution_model' => :'String',
+        :'closer_percent' => :'Float',
+        :'lookback_days' => :'Integer',
+        :'mode' => :'String',
+        :'originator_percent' => :'Float',
+        :'platforms' => :'Array<SfvbSmartAttributionPlatform>'
+      }
+    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::SfvbSmartAttributionRequest` 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::SfvbSmartAttributionRequest`. 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?(:'assist_percent')
+        self.assist_percent = attributes[:'assist_percent']
+      end
+
+      if attributes.key?(:'attribution_model')
+        self.attribution_model = attributes[:'attribution_model']
+      end
+
+      if attributes.key?(:'closer_percent')
+        self.closer_percent = attributes[:'closer_percent']
+      end
+
+      if attributes.key?(:'lookback_days')
+        self.lookback_days = attributes[:'lookback_days']
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.key?(:'originator_percent')
+        self.originator_percent = attributes[:'originator_percent']
+      end
+
+      if attributes.key?(:'platforms')
+        if (value = attributes[:'platforms']).is_a?(Array)
+          self.platforms = value
+        end
+      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 &&
+          assist_percent == o.assist_percent &&
+          attribution_model == o.attribution_model &&
+          closer_percent == o.closer_percent &&
+          lookback_days == o.lookback_days &&
+          mode == o.mode &&
+          originator_percent == o.originator_percent &&
+          platforms == o.platforms
+    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
+      [assist_percent, attribution_model, closer_percent, lookback_days, mode, originator_percent, platforms].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