class Plaid::CustomerInitiatedReturnRisk
The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include: "R05", "R07", "R10", "R11", "R29". These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.
Attributes
DEPRECATED. Use Signal Rules instead to transform the ‘score` into a useful action. A tier corresponding to the projected likelihood that the transaction, if initiated, will be subject to a return. In the `customer_initiated_return_risk` object, there are five risk tiers corresponding to the scores: 1: Predicted customer-initiated return incidence rate between 0.00% - 0.02% 2: Predicted customer-initiated return incidence rate between 0.02% - 0.05% 3: Predicted customer-initiated return incidence rate between 0.05% - 0.1% 4: Predicted customer-initiated return incidence rate between 0.1% - 0.5% 5: Predicted customer-initiated return incidence rate greater than 0.5%
A score from 1-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.
Public Class Methods
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 34 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 26 def self.attribute_map { :'score' => :'score', :'risk_tier' => :'risk_tier' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 183 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
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 54 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CustomerInitiatedReturnRisk` 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 `Plaid::CustomerInitiatedReturnRisk`. 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?(:'score') self.score = attributes[:'score'] end if attributes.key?(:'risk_tier') self.risk_tier = attributes[:'risk_tier'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 47 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 39 def self.openapi_types { :'score' => :'Integer', :'risk_tier' => :'Integer' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 161 def ==(o) return true if self.equal?(o) self.class == o.class && score == o.score && risk_tier == o.risk_tier end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 214 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 = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 285 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
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
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 190 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 170 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 176 def hash [score, risk_tier].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 78 def list_invalid_properties invalid_properties = Array.new if @score.nil? invalid_properties.push('invalid value for "score", score cannot be nil.') end if @score > 99 invalid_properties.push('invalid value for "score", must be smaller than or equal to 99.') end if @score < 1 invalid_properties.push('invalid value for "score", must be greater than or equal to 1.') end if @risk_tier.nil? invalid_properties.push('invalid value for "risk_tier", risk_tier cannot be nil.') end if @risk_tier > 5 invalid_properties.push('invalid value for "risk_tier", must be smaller than or equal to 5.') end if @risk_tier < 1 invalid_properties.push('invalid value for "risk_tier", must be greater than or equal to 1.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 142 def risk_tier=(risk_tier) if risk_tier.nil? fail ArgumentError, 'risk_tier cannot be nil' end if risk_tier > 5 fail ArgumentError, 'invalid value for "risk_tier", must be smaller than or equal to 5.' end if risk_tier < 1 fail ArgumentError, 'invalid value for "risk_tier", must be greater than or equal to 1.' end @risk_tier = risk_tier end
Custom attribute writer method with validation @param [Object] risk_tier
Value to be assigned
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 123 def score=(score) if score.nil? fail ArgumentError, 'score cannot be nil' end if score > 99 fail ArgumentError, 'invalid value for "score", must be smaller than or equal to 99.' end if score < 1 fail ArgumentError, 'invalid value for "score", must be greater than or equal to 1.' end @score = score end
Custom attribute writer method with validation @param [Object] score Value to be assigned
Source
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 267 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 255 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/customer_initiated_return_risk.rb, line 111 def valid? return false if @score.nil? return false if @score > 99 return false if @score < 1 return false if @risk_tier.nil? return false if @risk_tier > 5 return false if @risk_tier < 1 true end
Check to see if the all the properties in the model are valid @return true if the model is valid