Class: ThePlaidApi::TransactionsEnhanceGetResponse

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

Overview

TransactionsEnhanceGetResponse defines the response schema for ‘/beta/transactions/v1/enhance`.

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(enhanced_transactions:, additional_properties: nil) ⇒ TransactionsEnhanceGetResponse

Returns a new instance of TransactionsEnhanceGetResponse.



34
35
36
37
38
39
40
 
# File 'lib/the_plaid_api/models/transactions_enhance_get_response.rb', line 34

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

  @enhanced_transactions = enhanced_transactions
  @additional_properties = additional_properties
end

Instance Attribute Details

#enhanced_transactions ⇒ Array[ClientProvidedEnhancedTransaction]

An array of enhanced transactions.

Returns:



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

def enhanced_transactions
  @enhanced_transactions
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/the_plaid_api/models/transactions_enhance_get_response.rb', line 43

def self.from_hash(hash)
  return nil unless hash

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

  enhanced_transactions = nil unless hash.key?('enhanced_transactions')

  # 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.
  TransactionsEnhanceGetResponse.new(enhanced_transactions: enhanced_transactions,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/the_plaid_api/models/transactions_enhance_get_response.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



30
31
32
 
# File 'lib/the_plaid_api/models/transactions_enhance_get_response.rb', line 30

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



25
26
27
 
# File 'lib/the_plaid_api/models/transactions_enhance_get_response.rb', line 25

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



78
79
80
81
82
 
# File 'lib/the_plaid_api/models/transactions_enhance_get_response.rb', line 78

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



71
72
73
74
75
 
# File 'lib/the_plaid_api/models/transactions_enhance_get_response.rb', line 71

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