Class: ThePlaidApi::FraudAmount

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/fraud_amount.rb

Overview

The amount and currency of the fraud or attempted fraud. ‘fraud_amount` should be omitted to indicate an unknown fraud amount.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(value:, additional_properties: nil) ⇒ FraudAmount

Returns a new instance of FraudAmount.



41
42
43
44
45
46
47
48
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 41

def initialize(value:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @iso_currency_code = 'USD'
  @value = value
  @additional_properties = additional_properties
end

Instance Attribute Details

#iso_currency_code ⇒ String (readonly)

An ISO-4217 currency code.

Returns:

  • (String) 


15
16
17
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 15

def iso_currency_code
  @iso_currency_code
end

#value ⇒ Float

The amount value. This value can be 0 to indicate no money was lost. Must not contain more than two digits of precision (e.g., ‘1.23`).

Returns:

  • (Float) 


21
22
23
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 21

def value
  @value
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 51

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  value = hash.key?('value') ? hash['value'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  FraudAmount.new(value: value,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



24
25
26
27
28
29
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 24

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['iso_currency_code'] = 'iso_currency_code'
  @_hash['value'] = 'value'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



32
33
34
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 32

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



77
78
79
80
81
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 77

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} iso_currency_code: #{@iso_currency_code.inspect}, value: #{@value.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



70
71
72
73
74
 
# File 'lib/the_plaid_api/models/fraud_amount.rb', line 70

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} iso_currency_code: #{@iso_currency_code}, value: #{@value},"\
  " additional_properties: #{@additional_properties}>"
end