Class: ThePlaidApi::CraIncomeTransactionOutlier

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

Overview

Metadata on whether this income transaction is an outlier.

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(is_outlier:, amount: SKIP, additional_properties: nil) ⇒ CraIncomeTransactionOutlier

Returns a new instance of CraIncomeTransactionOutlier.



44
45
46
47
48
49
50
51
 
# File 'lib/the_plaid_api/models/cra_income_transaction_outlier.rb', line 44

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

  @is_outlier = is_outlier
  @amount = amount unless amount == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount ⇒ Float

The amount that the transaction differs from the stream average transaction amount.

Returns:

  • (Float) 


20
21
22
 
# File 'lib/the_plaid_api/models/cra_income_transaction_outlier.rb', line 20

def amount
  @amount
end

#is_outlier ⇒ TrueClass | FalseClass

Indicates whether an income transaction amount is unusually high compared to the amounts for that stream.

Returns:

  • (TrueClass | FalseClass) 


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

def is_outlier
  @is_outlier
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/the_plaid_api/models/cra_income_transaction_outlier.rb', line 54

def self.from_hash(hash)
  return nil unless hash

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

  # 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.
  CraIncomeTransactionOutlier.new(is_outlier: is_outlier,
                                  amount: amount,
                                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



38
39
40
41
42
 
# File 'lib/the_plaid_api/models/cra_income_transaction_outlier.rb', line 38

def self.nullables
  %w[
    amount
  ]
end

.optionals ⇒ Object

An array for optional fields



31
32
33
34
35
 
# File 'lib/the_plaid_api/models/cra_income_transaction_outlier.rb', line 31

def self.optionals
  %w[
    amount
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



82
83
84
85
86
 
# File 'lib/the_plaid_api/models/cra_income_transaction_outlier.rb', line 82

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



75
76
77
78
79
 
# File 'lib/the_plaid_api/models/cra_income_transaction_outlier.rb', line 75

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