ultracart_api 4.1.96 → 4.1.97

data/lib/ultracart_api/models/fraud_lookup_values.rb

@@ -18,30 +18,50 @@ module UltracartClient
     # Affiliates with non-empty email, sorted by email.
     attr_accessor :affiliates
 
+    # Valid values for avs_match_type on the 'address street and zip avs' rule type.
+    attr_accessor :avs_match_types
+
     # ISO country codes available to this merchant.
     attr_accessor :countries
 
+    # Valid values for failure_action on insert and search requests.
+    attr_accessor :failure_actions
+
     # Valid values for ip_range_type on IP-based rules.
     attr_accessor :ip_range_types
 
     # True when this merchant has at least one linked merchant account.
     attr_accessor :linked_accounts
 
+    # Rotating transaction gateways configured for this merchant. Use the oid as a value in rotating_transaction_gateway_filters on insert.
+    attr_accessor :rotating_transaction_gateways
+
     # Valid values for rule_group on search requests.
     attr_accessor :rule_groups
 
     # Valid values for rule_type on insert and search requests.
     attr_accessor :rule_types
 
+    # Screen branding themes configured for this merchant. Use the oid as a value in screen_branding_theme_filters on insert.
+    attr_accessor :screen_branding_themes
+
+    # Valid values for user_action on rule types that distinguish between attempted and approved transactions.
+    attr_accessor :user_actions
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'affiliates' => :'affiliates',
+        :'avs_match_types' => :'avs_match_types',
         :'countries' => :'countries',
+        :'failure_actions' => :'failure_actions',
         :'ip_range_types' => :'ip_range_types',
         :'linked_accounts' => :'linked_accounts',
+        :'rotating_transaction_gateways' => :'rotating_transaction_gateways',
         :'rule_groups' => :'rule_groups',
-        :'rule_types' => :'rule_types'
+        :'rule_types' => :'rule_types',
+        :'screen_branding_themes' => :'screen_branding_themes',
+        :'user_actions' => :'user_actions'
       }
     end
 
@@ -53,12 +73,17 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'affiliates' => :'Object',
-        :'countries' => :'Object',
-        :'ip_range_types' => :'Object',
+        :'affiliates' => :'Array<FraudLookupAffiliate>',
+        :'avs_match_types' => :'Array<String>',
+        :'countries' => :'Array<String>',
+        :'failure_actions' => :'Array<String>',
+        :'ip_range_types' => :'Array<String>',
         :'linked_accounts' => :'Boolean',
-        :'rule_groups' => :'Object',
-        :'rule_types' => :'Object'
+        :'rotating_transaction_gateways' => :'Array<FraudLookupGateway>',
+        :'rule_groups' => :'Array<String>',
+        :'rule_types' => :'Array<String>',
+        :'screen_branding_themes' => :'Array<FraudLookupTheme>',
+        :'user_actions' => :'Array<String>'
       }
     end
 
@@ -84,27 +109,67 @@ module UltracartClient
       }
 
       if attributes.key?(:'affiliates')
-        self.affiliates = attributes[:'affiliates']
+        if (value = attributes[:'affiliates']).is_a?(Array)
+          self.affiliates = value
+        end
+      end
+
+      if attributes.key?(:'avs_match_types')
+        if (value = attributes[:'avs_match_types']).is_a?(Array)
+          self.avs_match_types = value
+        end
       end
 
       if attributes.key?(:'countries')
-        self.countries = attributes[:'countries']
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      end
+
+      if attributes.key?(:'failure_actions')
+        if (value = attributes[:'failure_actions']).is_a?(Array)
+          self.failure_actions = value
+        end
       end
 
       if attributes.key?(:'ip_range_types')
-        self.ip_range_types = attributes[:'ip_range_types']
+        if (value = attributes[:'ip_range_types']).is_a?(Array)
+          self.ip_range_types = value
+        end
       end
 
       if attributes.key?(:'linked_accounts')
         self.linked_accounts = attributes[:'linked_accounts']
       end
 
+      if attributes.key?(:'rotating_transaction_gateways')
+        if (value = attributes[:'rotating_transaction_gateways']).is_a?(Array)
+          self.rotating_transaction_gateways = value
+        end
+      end
+
       if attributes.key?(:'rule_groups')
-        self.rule_groups = attributes[:'rule_groups']
+        if (value = attributes[:'rule_groups']).is_a?(Array)
+          self.rule_groups = value
+        end
       end
 
       if attributes.key?(:'rule_types')
-        self.rule_types = attributes[:'rule_types']
+        if (value = attributes[:'rule_types']).is_a?(Array)
+          self.rule_types = value
+        end
+      end
+
+      if attributes.key?(:'screen_branding_themes')
+        if (value = attributes[:'screen_branding_themes']).is_a?(Array)
+          self.screen_branding_themes = value
+        end
+      end
+
+      if attributes.key?(:'user_actions')
+        if (value = attributes[:'user_actions']).is_a?(Array)
+          self.user_actions = value
+        end
       end
     end
 
@@ -127,11 +192,16 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           affiliates == o.affiliates &&
+          avs_match_types == o.avs_match_types &&
           countries == o.countries &&
+          failure_actions == o.failure_actions &&
           ip_range_types == o.ip_range_types &&
           linked_accounts == o.linked_accounts &&
+          rotating_transaction_gateways == o.rotating_transaction_gateways &&
           rule_groups == o.rule_groups &&
-          rule_types == o.rule_types
+          rule_types == o.rule_types &&
+          screen_branding_themes == o.screen_branding_themes &&
+          user_actions == o.user_actions
     end
 
     # @see the `==` method
@@ -143,7 +213,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [affiliates, countries, ip_range_types, linked_accounts, rule_groups, rule_types].hash
+      [affiliates, avs_match_types, countries, failure_actions, ip_range_types, linked_accounts, rotating_transaction_gateways, rule_groups, rule_types, screen_branding_themes, user_actions].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/fraud_rule_from_order_request.rb

@@ -0,0 +1,314 @@
+=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 FraudRuleFromOrderRequest
+    # Note automatically appended to the order's merchant note when these rules fire.
+    attr_accessor :auto_note
+
+    # Establish an 'address street and zip avs' rule from the order's ship-to street and zip.
+    attr_accessor :establish_address_filter
+
+    # Establish a 'credit card matches' rule by duplicating the order's stored card vault token. Skipped if the order has no stored card.
+    attr_accessor :establish_card_filter
+
+    # Establish an 'address email' rule from the order's email address.
+    attr_accessor :establish_email_filter
+
+    # Establish an 'ip matches' subnet rule from the order's customer IP address (last octet masked to a subnet).
+    attr_accessor :establish_ip_filter
+
+    # Action to take when these rules fire. Defaults to 'Flag For Review' when omitted.
+    attr_accessor :failure_action
+
+    # The order id to establish the fraud rule(s) from.
+    attr_accessor :order_id
+
+    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
+      {
+        :'auto_note' => :'auto_note',
+        :'establish_address_filter' => :'establish_address_filter',
+        :'establish_card_filter' => :'establish_card_filter',
+        :'establish_email_filter' => :'establish_email_filter',
+        :'establish_ip_filter' => :'establish_ip_filter',
+        :'failure_action' => :'failure_action',
+        :'order_id' => :'order_id'
+      }
+    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
+      {
+        :'auto_note' => :'String',
+        :'establish_address_filter' => :'Boolean',
+        :'establish_card_filter' => :'Boolean',
+        :'establish_email_filter' => :'Boolean',
+        :'establish_ip_filter' => :'Boolean',
+        :'failure_action' => :'String',
+        :'order_id' => :'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::FraudRuleFromOrderRequest` 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::FraudRuleFromOrderRequest`. 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?(:'auto_note')
+        self.auto_note = attributes[:'auto_note']
+      end
+
+      if attributes.key?(:'establish_address_filter')
+        self.establish_address_filter = attributes[:'establish_address_filter']
+      end
+
+      if attributes.key?(:'establish_card_filter')
+        self.establish_card_filter = attributes[:'establish_card_filter']
+      end
+
+      if attributes.key?(:'establish_email_filter')
+        self.establish_email_filter = attributes[:'establish_email_filter']
+      end
+
+      if attributes.key?(:'establish_ip_filter')
+        self.establish_ip_filter = attributes[:'establish_ip_filter']
+      end
+
+      if attributes.key?(:'failure_action')
+        self.failure_action = attributes[:'failure_action']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      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?
+      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)
+      true
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          auto_note == o.auto_note &&
+          establish_address_filter == o.establish_address_filter &&
+          establish_card_filter == o.establish_card_filter &&
+          establish_email_filter == o.establish_email_filter &&
+          establish_ip_filter == o.establish_ip_filter &&
+          failure_action == o.failure_action &&
+          order_id == o.order_id
+    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
+      [auto_note, establish_address_filter, establish_card_filter, establish_email_filter, establish_ip_filter, failure_action, order_id].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/fraud_rule_insert_request.rb

@@ -66,22 +66,31 @@ module UltracartClient
     # Merchant item id. Used by the 'item matches' rule type.
     attr_accessor :merchant_item_id
 
+    # When failure_action is 'Process Payment and Modify', set order custom field 1 to this value.
     attr_accessor :modify_custom_field1
 
+    # When failure_action is 'Process Payment and Modify', set order custom field 2 to this value.
     attr_accessor :modify_custom_field2
 
+    # When failure_action is 'Process Payment and Modify', set order custom field 3 to this value.
     attr_accessor :modify_custom_field3
 
+    # When failure_action is 'Process Payment and Modify', set order custom field 4 to this value.
     attr_accessor :modify_custom_field4
 
+    # When failure_action is 'Process Payment and Modify', set order custom field 5 to this value.
     attr_accessor :modify_custom_field5
 
+    # When failure_action is 'Process Payment and Modify', set order custom field 6 to this value.
     attr_accessor :modify_custom_field6
 
+    # When failure_action is 'Process Payment and Modify', set order custom field 7 to this value.
     attr_accessor :modify_custom_field7
 
+    # When failure_action is 'Process Payment and Modify', strip the affiliate from the order.
     attr_accessor :modify_skip_affiliate
 
+    # When failure_action is 'Process Payment and Modify', skip firing the affiliate network pixel.
     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.
@@ -170,14 +179,14 @@ module UltracartClient
         :'avs_response_codes' => :'String',
         :'count_threshold' => :'Integer',
         :'country_code' => :'String',
-        :'credit_card_bins' => :'Object',
+        :'credit_card_bins' => :'Array<String>',
         :'email' => :'String',
         :'failure_action' => :'String',
         :'gateway_response_codes' => :'String',
         :'gateway_response_value' => :'String',
         :'ip_address' => :'String',
         :'ip_range_type' => :'String',
-        :'item_filters' => :'Object',
+        :'item_filters' => :'Array<String>',
         :'merchant_item_id' => :'String',
         :'modify_custom_field1' => :'String',
         :'modify_custom_field2' => :'String',
@@ -188,9 +197,9 @@ module UltracartClient
         :'modify_custom_field7' => :'String',
         :'modify_skip_affiliate' => :'Boolean',
         :'modify_skip_affiliate_network_pixel' => :'Boolean',
-        :'rotating_transaction_gateway_filters' => :'Object',
+        :'rotating_transaction_gateway_filters' => :'Array<Integer>',
         :'rule_type' => :'String',
-        :'screen_branding_theme_filters' => :'Object',
+        :'screen_branding_theme_filters' => :'Array<Integer>',
         :'user_action' => :'String'
       }
     end
@@ -249,7 +258,9 @@ module UltracartClient
       end
 
       if attributes.key?(:'credit_card_bins')
-        self.credit_card_bins = attributes[:'credit_card_bins']
+        if (value = attributes[:'credit_card_bins']).is_a?(Array)
+          self.credit_card_bins = value
+        end
       end
 
       if attributes.key?(:'email')
@@ -277,7 +288,9 @@ module UltracartClient
       end
 
       if attributes.key?(:'item_filters')
-        self.item_filters = attributes[:'item_filters']
+        if (value = attributes[:'item_filters']).is_a?(Array)
+          self.item_filters = value
+        end
       end
 
       if attributes.key?(:'merchant_item_id')
@@ -321,7 +334,9 @@ module UltracartClient
       end
 
       if attributes.key?(:'rotating_transaction_gateway_filters')
-        self.rotating_transaction_gateway_filters = attributes[:'rotating_transaction_gateway_filters']
+        if (value = attributes[:'rotating_transaction_gateway_filters']).is_a?(Array)
+          self.rotating_transaction_gateway_filters = value
+        end
       end
 
       if attributes.key?(:'rule_type')
@@ -329,7 +344,9 @@ module UltracartClient
       end
 
       if attributes.key?(:'screen_branding_theme_filters')
-        self.screen_branding_theme_filters = attributes[:'screen_branding_theme_filters']
+        if (value = attributes[:'screen_branding_theme_filters']).is_a?(Array)
+          self.screen_branding_theme_filters = value
+        end
       end
 
       if attributes.key?(:'user_action')