Class: LoyaltyApIs::TransactionBalance

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/loyalty_ap_is/models/transaction_balance.rb

Overview

TransactionBalance Model.

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(currency_type:, amounts:, additional_properties: nil) ⇒ TransactionBalance

Returns a new instance of TransactionBalance.



38
39
40
41
42
43
44
45
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 38

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

  @currency_type = currency_type
  @amounts = amounts
  @additional_properties = additional_properties
end

Instance Attribute Details

#amounts ⇒ Array[TransactionBalanceAmount]

Type of balance

Returns:



18
19
20
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 18

def amounts
  @amounts
end

#currency_type ⇒ TransactionCurrencyType

Type of balance

Returns:



14
15
16
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 14

def currency_type
  @currency_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 48

def self.from_hash(hash)
  return nil unless hash

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

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

  # 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.
  TransactionBalance.new(currency_type: currency_type,
                         amounts: amounts,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 21

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

.nullables ⇒ Object

An array for nullable fields



34
35
36
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 29

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



85
86
87
88
89
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 85

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



78
79
80
81
82
 
# File 'lib/loyalty_ap_is/models/transaction_balance.rb', line 78

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