ultracart_api 4.1.96 → 4.1.98

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')

data/lib/ultracart_api/models/fraud_rule_public.rb

@@ -15,21 +15,27 @@ require 'time'
 
 module UltracartClient
   class FraudRulePublic
+    # Affiliate oid for the 'affiliate matches' rule type.
     attr_accessor :affiliate_oid
 
+    # Monetary or score threshold for amount/score/percentage rule types.
     attr_accessor :amount_threshold
 
+    # Note automatically appended to the order's merchant note when this rule fires.
     attr_accessor :auto_note
 
     attr_accessor :avs_match_type
 
+    # AVS response codes for the 'address street and zip avs' rule type.
     attr_accessor :avs_response_codes
 
     # Masked credit card number for rules tied to a specific card
     attr_accessor :card_number
 
+    # Integer count threshold for count/quantity/hours rule types.
     attr_accessor :count_threshold
 
+    # ISO country code for the 'address not in country' rule type.
     attr_accessor :country_code
 
     attr_accessor :created_by
@@ -40,6 +46,7 @@ module UltracartClient
     # Credit card BINs blocked by the 'credit card block bin' rule type.
     attr_accessor :credit_card_bins
 
+    # Message shown in the A/R review screen when this rule fires.
     attr_accessor :decline_message
 
     # Human-readable description of the rule
@@ -48,6 +55,7 @@ module UltracartClient
     # HTML version of the rule description
     attr_accessor :description_html
 
+    # Email address for the 'address email' rule type.
     attr_accessor :email
 
     # Action taken when this rule fires.
@@ -56,36 +64,51 @@ module UltracartClient
     # UltraCart unique identifier for this fraud rule
     attr_accessor :fraud_rule_oid
 
+    # Gateway response code key for the 'gateway response' rule type.
     attr_accessor :gateway_response_codes
 
+    # Gateway response code value for the 'gateway response' rule type.
     attr_accessor :gateway_response_value
 
+    # IP address or subnet for 'exempt ip' and 'ip matches' rule types.
     attr_accessor :ip_address
 
     attr_accessor :ip_range_type
 
+    # Item filters restricting this rule to orders containing one or more of these items.
     attr_accessor :item_filters
 
+    # Merchant item id for the 'item matches' rule type.
     attr_accessor :merchant_item_id
 
+    # Value the rule sets on order custom field 1 (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_custom_field1
 
+    # Value the rule sets on order custom field 2 (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_custom_field2
 
+    # Value the rule sets on order custom field 3 (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_custom_field3
 
+    # Value the rule sets on order custom field 4 (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_custom_field4
 
+    # Value the rule sets on order custom field 5 (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_custom_field5
 
+    # Value the rule sets on order custom field 6 (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_custom_field6
 
+    # Value the rule sets on order custom field 7 (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_custom_field7
 
+    # When true, the rule strips the affiliate from the order (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_skip_affiliate
 
+    # When true, the rule suppresses the affiliate network pixel (only meaningful for 'Process Payment and Modify').
     attr_accessor :modify_skip_affiliate_network_pixel
 
+    # Gateway filters restricting this rule to orders processed by one of these rotating transaction gateways.
     attr_accessor :rotating_transaction_gateway_filters
 
     # Group containing this rule type (eg 'creditCardRules'). Deliberately not constrained by allowableValues on the response so SDK consumers do not hard-fail on an unexpected value if a future rule_type slips through the server-side mapping. Search REQUESTS still restrict rule_group to the known set.
@@ -94,6 +117,7 @@ module UltracartClient
     # Rule type.
     attr_accessor :rule_type
 
+    # Storefront filters restricting this rule to orders placed on one of these storefronts.
     attr_accessor :storefront_filters
 
     attr_accessor :user_action
@@ -181,7 +205,7 @@ module UltracartClient
         :'country_code' => :'String',
         :'created_by' => :'String',
         :'created_dts' => :'String',
-        :'credit_card_bins' => :'Object',
+        :'credit_card_bins' => :'Array<String>',
         :'decline_message' => :'String',
         :'description' => :'String',
         :'description_html' => :'String',
@@ -273,7 +297,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?(:'decline_message')

data/lib/ultracart_api/models/fraud_rule_search_request.rb

@@ -21,6 +21,7 @@ module UltracartClient
     # Lower bound on amount/score/percentage thresholds (rules backed by the same numeric column).
     attr_accessor :amount_threshold_begin
 
+    # Upper bound on amount/score/percentage thresholds (rules backed by the same numeric column).
     attr_accessor :amount_threshold_end
 
     # Wildcard search on the rule's auto_note. Use '*' for wildcards.
@@ -29,8 +30,10 @@ module UltracartClient
     # Lower bound on count thresholds (rules backed by the same integer count column).
     attr_accessor :count_threshold_begin
 
+    # Upper bound on count thresholds (rules backed by the same integer count column).
     attr_accessor :count_threshold_end
 
+    # Filter to rules created by this user login.
     attr_accessor :created_by
 
     # Rule creation date begin (MM/dd/yyyy)
@@ -47,29 +50,40 @@ module UltracartClient
 
     attr_accessor :failure_action
 
+    # Filter to rules with this rotating transaction gateway code in their rotating_transaction_gateway_filters list.
     attr_accessor :gateway_code
 
+    # Filter to rules with this merchant item id in their item_filters list.
     attr_accessor :merchant_item_id
 
     # Wildcard search on the rule's secondary modifier (eg 'address'/'subnet', gateway codes, avs match types).
     attr_accessor :modifier_value
 
+    # Wildcard search on rules' modify_custom_field1 value.
     attr_accessor :modify_custom_field1
 
+    # Wildcard search on rules' modify_custom_field2 value.
     attr_accessor :modify_custom_field2
 
+    # Wildcard search on rules' modify_custom_field3 value.
     attr_accessor :modify_custom_field3
 
+    # Wildcard search on rules' modify_custom_field4 value.
     attr_accessor :modify_custom_field4
 
+    # Wildcard search on rules' modify_custom_field5 value.
     attr_accessor :modify_custom_field5
 
+    # Wildcard search on rules' modify_custom_field6 value.
     attr_accessor :modify_custom_field6
 
+    # Wildcard search on rules' modify_custom_field7 value.
     attr_accessor :modify_custom_field7
 
+    # Filter to rules whose modify_skip_affiliate flag matches this value.
     attr_accessor :modify_skip_affiliate
 
+    # Filter to rules whose modify_skip_affiliate_network_pixel flag matches this value.
     attr_accessor :modify_skip_affiliate_network_pixel
 
     # Rule group to filter by.
@@ -81,11 +95,13 @@ module UltracartClient
     # Include rules from accounts linked to this merchant. Defaults to false.
     attr_accessor :search_linked_accounts
 
+    # Filter to rules with this storefront hostname in their screen_branding_theme_filters list.
     attr_accessor :storefront_hostname
 
     # Wildcard search on the rule's text parameter (email / ip / bin / country / item id / avs codes - the backend disambiguates by rule_type).
     attr_accessor :text_value
 
+    # Filter to rules with this screen branding theme code in their screen_branding_theme_filters list.
     attr_accessor :theme_code
 
     attr_accessor :user_action

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.96'
+  VERSION = '4.1.98'
 end

data/lib/ultracart_api.rb

@@ -329,6 +329,7 @@ require 'ultracart_api/models/countries_response'
 require 'ultracart_api/models/country'
 require 'ultracart_api/models/coupon'
 require 'ultracart_api/models/coupon_amount_off_items'
+require 'ultracart_api/models/coupon_amount_off_items_and_free_shipping'
 require 'ultracart_api/models/coupon_amount_off_shipping'
 require 'ultracart_api/models/coupon_amount_off_shipping_with_items_purchase'
 require 'ultracart_api/models/coupon_amount_off_subtotal'
@@ -602,8 +603,12 @@ require 'ultracart_api/models/file_manager_page_response'
 require 'ultracart_api/models/file_manager_upload_request'
 require 'ultracart_api/models/file_manager_upload_url_response'
 require 'ultracart_api/models/fraud_decline_email_request'
+require 'ultracart_api/models/fraud_lookup_affiliate'
+require 'ultracart_api/models/fraud_lookup_gateway'
+require 'ultracart_api/models/fraud_lookup_theme'
 require 'ultracart_api/models/fraud_lookup_values'
 require 'ultracart_api/models/fraud_lookup_values_response'
+require 'ultracart_api/models/fraud_rule_from_order_request'
 require 'ultracart_api/models/fraud_rule_insert_request'
 require 'ultracart_api/models/fraud_rule_item_filter'
 require 'ultracart_api/models/fraud_rule_public'