ultracart_api 4.1.92 → 4.1.94

data/lib/ultracart_api/models/fraud_rule_insert_request.rb

@@ -0,0 +1,583 @@
+=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 FraudRuleInsertRequest
+    # Affiliate email. Used by the 'affiliate matches' rule type when affiliate_oid is not supplied.
+    attr_accessor :affiliate_email
+
+    # Affiliate OID. Used by the 'affiliate matches' rule type. If omitted, affiliate_email is required.
+    attr_accessor :affiliate_oid
+
+    # Monetary or score threshold. Used by *transaction amount exceeds*, *fraud score exceeds*, and *decline percentage exceeds* rules.
+    attr_accessor :amount_threshold
+
+    # Note automatically appended to the order's merchant note when this rule fires.
+    attr_accessor :auto_note
+
+    # AVS match type for the zip portion. Used by the 'address street and zip avs' rule type.
+    attr_accessor :avs_match_type
+
+    # AVS response codes (street). Used by the 'address street and zip avs' rule type.
+    attr_accessor :avs_response_codes
+
+    # Integer count threshold. Used by *count exceeds*, *change number*, *quantity exceeds*, and *purchased within last hours* rules.
+    attr_accessor :count_threshold
+
+    # ISO country code. Used by the 'address not in country' rule type.
+    attr_accessor :country_code
+
+    # Credit card BINs to block (max 20). Used by the 'credit card block bin' rule type.
+    attr_accessor :credit_card_bins
+
+    # Email address. Used by the 'address email' rule type.
+    attr_accessor :email
+
+    # Action to take when this rule fires.
+    attr_accessor :failure_action
+
+    # Gateway response code key. Used by the 'gateway response' rule type.
+    attr_accessor :gateway_response_codes
+
+    # Gateway response code value. Used by the 'gateway response' rule type.
+    attr_accessor :gateway_response_value
+
+    # IP address or subnet (eg '192.168.1.1' or '10.0.0.0/8'). Used by 'exempt ip' and 'ip matches' rules.
+    attr_accessor :ip_address
+
+    # Specifies whether an IP rule applies to a single address or a subnet.
+    attr_accessor :ip_range_type
+
+    # Optional list of merchant item ids restricting this rule to orders containing one or more of these items.
+    attr_accessor :item_filters
+
+    # Merchant item id. Used by the 'item matches' rule type.
+    attr_accessor :merchant_item_id
+
+    attr_accessor :modify_custom_field1
+
+    attr_accessor :modify_custom_field2
+
+    attr_accessor :modify_custom_field3
+
+    attr_accessor :modify_custom_field4
+
+    attr_accessor :modify_custom_field5
+
+    attr_accessor :modify_custom_field6
+
+    attr_accessor :modify_custom_field7
+
+    attr_accessor :modify_skip_affiliate
+
+    attr_accessor :modify_skip_affiliate_network_pixel
+
+    # Optional list of rotating transaction gateway oids restricting this rule to orders processed by one of these gateways.
+    attr_accessor :rotating_transaction_gateway_filters
+
+    # Rule type. Also returned by GET /v2/fraud/lookup_values.
+    attr_accessor :rule_type
+
+    # Optional list of screen branding theme oids restricting this rule to orders associated with one or more storefronts.
+    attr_accessor :screen_branding_theme_filters
+
+    # Only used by rule types that distinguish between attempted and approved transactions.
+    attr_accessor :user_action
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'affiliate_email' => :'affiliate_email',
+        :'affiliate_oid' => :'affiliate_oid',
+        :'amount_threshold' => :'amount_threshold',
+        :'auto_note' => :'auto_note',
+        :'avs_match_type' => :'avs_match_type',
+        :'avs_response_codes' => :'avs_response_codes',
+        :'count_threshold' => :'count_threshold',
+        :'country_code' => :'country_code',
+        :'credit_card_bins' => :'credit_card_bins',
+        :'email' => :'email',
+        :'failure_action' => :'failure_action',
+        :'gateway_response_codes' => :'gateway_response_codes',
+        :'gateway_response_value' => :'gateway_response_value',
+        :'ip_address' => :'ip_address',
+        :'ip_range_type' => :'ip_range_type',
+        :'item_filters' => :'item_filters',
+        :'merchant_item_id' => :'merchant_item_id',
+        :'modify_custom_field1' => :'modify_custom_field1',
+        :'modify_custom_field2' => :'modify_custom_field2',
+        :'modify_custom_field3' => :'modify_custom_field3',
+        :'modify_custom_field4' => :'modify_custom_field4',
+        :'modify_custom_field5' => :'modify_custom_field5',
+        :'modify_custom_field6' => :'modify_custom_field6',
+        :'modify_custom_field7' => :'modify_custom_field7',
+        :'modify_skip_affiliate' => :'modify_skip_affiliate',
+        :'modify_skip_affiliate_network_pixel' => :'modify_skip_affiliate_network_pixel',
+        :'rotating_transaction_gateway_filters' => :'rotating_transaction_gateway_filters',
+        :'rule_type' => :'rule_type',
+        :'screen_branding_theme_filters' => :'screen_branding_theme_filters',
+        :'user_action' => :'user_action'
+      }
+    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
+      {
+        :'affiliate_email' => :'String',
+        :'affiliate_oid' => :'Integer',
+        :'amount_threshold' => :'Float',
+        :'auto_note' => :'String',
+        :'avs_match_type' => :'String',
+        :'avs_response_codes' => :'String',
+        :'count_threshold' => :'Integer',
+        :'country_code' => :'String',
+        :'credit_card_bins' => :'Object',
+        :'email' => :'String',
+        :'failure_action' => :'String',
+        :'gateway_response_codes' => :'String',
+        :'gateway_response_value' => :'String',
+        :'ip_address' => :'String',
+        :'ip_range_type' => :'String',
+        :'item_filters' => :'Object',
+        :'merchant_item_id' => :'String',
+        :'modify_custom_field1' => :'String',
+        :'modify_custom_field2' => :'String',
+        :'modify_custom_field3' => :'String',
+        :'modify_custom_field4' => :'String',
+        :'modify_custom_field5' => :'String',
+        :'modify_custom_field6' => :'String',
+        :'modify_custom_field7' => :'String',
+        :'modify_skip_affiliate' => :'Boolean',
+        :'modify_skip_affiliate_network_pixel' => :'Boolean',
+        :'rotating_transaction_gateway_filters' => :'Object',
+        :'rule_type' => :'String',
+        :'screen_branding_theme_filters' => :'Object',
+        :'user_action' => :'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::FraudRuleInsertRequest` 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::FraudRuleInsertRequest`. 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?(:'affiliate_email')
+        self.affiliate_email = attributes[:'affiliate_email']
+      end
+
+      if attributes.key?(:'affiliate_oid')
+        self.affiliate_oid = attributes[:'affiliate_oid']
+      end
+
+      if attributes.key?(:'amount_threshold')
+        self.amount_threshold = attributes[:'amount_threshold']
+      end
+
+      if attributes.key?(:'auto_note')
+        self.auto_note = attributes[:'auto_note']
+      end
+
+      if attributes.key?(:'avs_match_type')
+        self.avs_match_type = attributes[:'avs_match_type']
+      end
+
+      if attributes.key?(:'avs_response_codes')
+        self.avs_response_codes = attributes[:'avs_response_codes']
+      end
+
+      if attributes.key?(:'count_threshold')
+        self.count_threshold = attributes[:'count_threshold']
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
+
+      if attributes.key?(:'credit_card_bins')
+        self.credit_card_bins = attributes[:'credit_card_bins']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'failure_action')
+        self.failure_action = attributes[:'failure_action']
+      end
+
+      if attributes.key?(:'gateway_response_codes')
+        self.gateway_response_codes = attributes[:'gateway_response_codes']
+      end
+
+      if attributes.key?(:'gateway_response_value')
+        self.gateway_response_value = attributes[:'gateway_response_value']
+      end
+
+      if attributes.key?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.key?(:'ip_range_type')
+        self.ip_range_type = attributes[:'ip_range_type']
+      end
+
+      if attributes.key?(:'item_filters')
+        self.item_filters = attributes[:'item_filters']
+      end
+
+      if attributes.key?(:'merchant_item_id')
+        self.merchant_item_id = attributes[:'merchant_item_id']
+      end
+
+      if attributes.key?(:'modify_custom_field1')
+        self.modify_custom_field1 = attributes[:'modify_custom_field1']
+      end
+
+      if attributes.key?(:'modify_custom_field2')
+        self.modify_custom_field2 = attributes[:'modify_custom_field2']
+      end
+
+      if attributes.key?(:'modify_custom_field3')
+        self.modify_custom_field3 = attributes[:'modify_custom_field3']
+      end
+
+      if attributes.key?(:'modify_custom_field4')
+        self.modify_custom_field4 = attributes[:'modify_custom_field4']
+      end
+
+      if attributes.key?(:'modify_custom_field5')
+        self.modify_custom_field5 = attributes[:'modify_custom_field5']
+      end
+
+      if attributes.key?(:'modify_custom_field6')
+        self.modify_custom_field6 = attributes[:'modify_custom_field6']
+      end
+
+      if attributes.key?(:'modify_custom_field7')
+        self.modify_custom_field7 = attributes[:'modify_custom_field7']
+      end
+
+      if attributes.key?(:'modify_skip_affiliate')
+        self.modify_skip_affiliate = attributes[:'modify_skip_affiliate']
+      end
+
+      if attributes.key?(:'modify_skip_affiliate_network_pixel')
+        self.modify_skip_affiliate_network_pixel = attributes[:'modify_skip_affiliate_network_pixel']
+      end
+
+      if attributes.key?(:'rotating_transaction_gateway_filters')
+        self.rotating_transaction_gateway_filters = attributes[:'rotating_transaction_gateway_filters']
+      end
+
+      if attributes.key?(:'rule_type')
+        self.rule_type = attributes[:'rule_type']
+      end
+
+      if attributes.key?(:'screen_branding_theme_filters')
+        self.screen_branding_theme_filters = attributes[:'screen_branding_theme_filters']
+      end
+
+      if attributes.key?(:'user_action')
+        self.user_action = attributes[:'user_action']
+      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?
+      avs_match_type_validator = EnumAttributeValidator.new('String', ["match", "no match", "partial"])
+      return false unless avs_match_type_validator.valid?(@avs_match_type)
+      failure_action_validator = EnumAttributeValidator.new('String', ["Flag For Review", "Process Payment and Modify", "Process Payment and Review", "Decline Transaction", "Exempt"])
+      return false unless failure_action_validator.valid?(@failure_action)
+      ip_range_type_validator = EnumAttributeValidator.new('String', ["address", "subnet"])
+      return false unless ip_range_type_validator.valid?(@ip_range_type)
+      rule_type_validator = EnumAttributeValidator.new('String', ["exempt apo fpo", "exempt ip", "exempt logged in customer with pricing tier", "credit card single transaction exceeds", "credit card daily transaction amount exceeds", "credit card daily transaction count exceeds", "credit card weekly transaction amount exceeds", "credit card weekly transaction count exceeds", "credit card change number", "credit card block bin", "credit card block prepaid", "amazon special instructions", "paypal special instructions", "reward coupon email mismatch", "gateway response", "ip daily transaction amount exceeds", "ip daily transaction count exceeds", "ip weekly transaction amount exceeds", "ip weekly transaction count exceeds", "ip matches", "ip country mismatch", "address fraud score exceeds", "address fraud score exceeds exempt apo fpo", "address street and zip avs", "address billing doesnt match shipping", "billing country doesnt match shipping", "address international", "address match except zip", "address email", "address not in country", "wholesale customer not logged in", "affiliate matches", "affiliate daily count exceeds", "affiliate weekly count exceeds", "affiliate daily decline percentage exceeds", "affiliate weekly decline percentage exceeds", "affiliate daily with same ip", "affiliate weekly with same ip", "item matches", "item quantity exceeds", "order previous return", "order purchased within last hours", "order used coupon meant for sharing", "browser os linux"])
+      return false unless rule_type_validator.valid?(@rule_type)
+      user_action_validator = EnumAttributeValidator.new('String', ["Attempted", "Approved"])
+      return false unless user_action_validator.valid?(@user_action)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] avs_match_type Object to be assigned
+    def avs_match_type=(avs_match_type)
+      validator = EnumAttributeValidator.new('String', ["match", "no match", "partial"])
+      unless validator.valid?(avs_match_type)
+        fail ArgumentError, "invalid value for \"avs_match_type\", must be one of #{validator.allowable_values}."
+      end
+      @avs_match_type = avs_match_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] failure_action Object to be assigned
+    def failure_action=(failure_action)
+      validator = EnumAttributeValidator.new('String', ["Flag For Review", "Process Payment and Modify", "Process Payment and Review", "Decline Transaction", "Exempt"])
+      unless validator.valid?(failure_action)
+        fail ArgumentError, "invalid value for \"failure_action\", must be one of #{validator.allowable_values}."
+      end
+      @failure_action = failure_action
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ip_range_type Object to be assigned
+    def ip_range_type=(ip_range_type)
+      validator = EnumAttributeValidator.new('String', ["address", "subnet"])
+      unless validator.valid?(ip_range_type)
+        fail ArgumentError, "invalid value for \"ip_range_type\", must be one of #{validator.allowable_values}."
+      end
+      @ip_range_type = ip_range_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] rule_type Object to be assigned
+    def rule_type=(rule_type)
+      validator = EnumAttributeValidator.new('String', ["exempt apo fpo", "exempt ip", "exempt logged in customer with pricing tier", "credit card single transaction exceeds", "credit card daily transaction amount exceeds", "credit card daily transaction count exceeds", "credit card weekly transaction amount exceeds", "credit card weekly transaction count exceeds", "credit card change number", "credit card block bin", "credit card block prepaid", "amazon special instructions", "paypal special instructions", "reward coupon email mismatch", "gateway response", "ip daily transaction amount exceeds", "ip daily transaction count exceeds", "ip weekly transaction amount exceeds", "ip weekly transaction count exceeds", "ip matches", "ip country mismatch", "address fraud score exceeds", "address fraud score exceeds exempt apo fpo", "address street and zip avs", "address billing doesnt match shipping", "billing country doesnt match shipping", "address international", "address match except zip", "address email", "address not in country", "wholesale customer not logged in", "affiliate matches", "affiliate daily count exceeds", "affiliate weekly count exceeds", "affiliate daily decline percentage exceeds", "affiliate weekly decline percentage exceeds", "affiliate daily with same ip", "affiliate weekly with same ip", "item matches", "item quantity exceeds", "order previous return", "order purchased within last hours", "order used coupon meant for sharing", "browser os linux"])
+      unless validator.valid?(rule_type)
+        fail ArgumentError, "invalid value for \"rule_type\", must be one of #{validator.allowable_values}."
+      end
+      @rule_type = rule_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] user_action Object to be assigned
+    def user_action=(user_action)
+      validator = EnumAttributeValidator.new('String', ["Attempted", "Approved"])
+      unless validator.valid?(user_action)
+        fail ArgumentError, "invalid value for \"user_action\", must be one of #{validator.allowable_values}."
+      end
+      @user_action = user_action
+    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 &&
+          affiliate_email == o.affiliate_email &&
+          affiliate_oid == o.affiliate_oid &&
+          amount_threshold == o.amount_threshold &&
+          auto_note == o.auto_note &&
+          avs_match_type == o.avs_match_type &&
+          avs_response_codes == o.avs_response_codes &&
+          count_threshold == o.count_threshold &&
+          country_code == o.country_code &&
+          credit_card_bins == o.credit_card_bins &&
+          email == o.email &&
+          failure_action == o.failure_action &&
+          gateway_response_codes == o.gateway_response_codes &&
+          gateway_response_value == o.gateway_response_value &&
+          ip_address == o.ip_address &&
+          ip_range_type == o.ip_range_type &&
+          item_filters == o.item_filters &&
+          merchant_item_id == o.merchant_item_id &&
+          modify_custom_field1 == o.modify_custom_field1 &&
+          modify_custom_field2 == o.modify_custom_field2 &&
+          modify_custom_field3 == o.modify_custom_field3 &&
+          modify_custom_field4 == o.modify_custom_field4 &&
+          modify_custom_field5 == o.modify_custom_field5 &&
+          modify_custom_field6 == o.modify_custom_field6 &&
+          modify_custom_field7 == o.modify_custom_field7 &&
+          modify_skip_affiliate == o.modify_skip_affiliate &&
+          modify_skip_affiliate_network_pixel == o.modify_skip_affiliate_network_pixel &&
+          rotating_transaction_gateway_filters == o.rotating_transaction_gateway_filters &&
+          rule_type == o.rule_type &&
+          screen_branding_theme_filters == o.screen_branding_theme_filters &&
+          user_action == o.user_action
+    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
+      [affiliate_email, affiliate_oid, amount_threshold, auto_note, avs_match_type, avs_response_codes, count_threshold, country_code, credit_card_bins, email, failure_action, gateway_response_codes, gateway_response_value, ip_address, ip_range_type, item_filters, merchant_item_id, modify_custom_field1, modify_custom_field2, modify_custom_field3, modify_custom_field4, modify_custom_field5, modify_custom_field6, modify_custom_field7, modify_skip_affiliate, modify_skip_affiliate_network_pixel, rotating_transaction_gateway_filters, rule_type, screen_branding_theme_filters, user_action].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