Class: ThePlaidApi::CreditFreddieMacAssetTransaction

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

Overview

An object representing…

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(asset_transaction_detail:, asset_transaction_description:, additional_properties: nil) ⇒ CreditFreddieMacAssetTransaction

Returns a new instance of CreditFreddieMacAssetTransaction.



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

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

  @asset_transaction_detail = asset_transaction_detail
  @asset_transaction_description = asset_transaction_description
  @additional_properties = additional_properties
end

Instance Attribute Details

#asset_transaction_description ⇒ Array[AssetTransactionDescription]

Documentation not found in the MISMO model viewer and not provided by Freddie Mac.

Returns:



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

def asset_transaction_description
  @asset_transaction_description
end

#asset_transaction_detail ⇒ AssetTransactionDetail

Documentation not found in the MISMO model viewer and not provided by Freddie Mac.

Returns:



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

def asset_transaction_detail
  @asset_transaction_detail
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/the_plaid_api/models/credit_freddie_mac_asset_transaction.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  if hash['ASSET_TRANSACTION_DETAIL']
    asset_transaction_detail = AssetTransactionDetail.from_hash(hash['ASSET_TRANSACTION_DETAIL'])
  end
  # Parameter is an array, so we need to iterate through it
  asset_transaction_description = nil
  unless hash['ASSET_TRANSACTION_DESCRIPTION'].nil?
    asset_transaction_description = []
    hash['ASSET_TRANSACTION_DESCRIPTION'].each do |structure|
      asset_transaction_description << (AssetTransactionDescription.from_hash(structure) if structure)
    end
  end

  asset_transaction_description = nil unless hash.key?('ASSET_TRANSACTION_DESCRIPTION')

  # 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.
  CreditFreddieMacAssetTransaction.new(asset_transaction_detail: asset_transaction_detail,
                                       asset_transaction_description: asset_transaction_description,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['asset_transaction_detail'] = 'ASSET_TRANSACTION_DETAIL'
  @_hash['asset_transaction_description'] =
    'ASSET_TRANSACTION_DESCRIPTION'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



92
93
94
95
96
97
 
# File 'lib/the_plaid_api/models/credit_freddie_mac_asset_transaction.rb', line 92

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



84
85
86
87
88
89
 
# File 'lib/the_plaid_api/models/credit_freddie_mac_asset_transaction.rb', line 84

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