fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/investment_account_entity.rb

@@ -0,0 +1,548 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'account_entity'
+
+module FdxApi
+  # An investment account type and information such as balances, transactions,
+  # holdings and privileges
+  class InvestmentAccountEntity < AccountEntity
+    # As-of date for balances
+    # @return [DateTime]
+    attr_accessor :balance_as_of
+
+    # Check writing privileges
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allowed_check_writing
+
+    # Allowed to trade options
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allowed_option_trade
+
+    # Total current value of all investments
+    # @return [Float]
+    attr_accessor :current_value
+
+    # Holdings in the investment account
+    # @return [Array[HoldingEntity]]
+    attr_accessor :holdings
+
+    # Open orders in the investment account
+    # @return [Array[OpenOrderEntity]]
+    attr_accessor :open_orders
+
+    # Describes how new contributions are distributed among the available
+    # securities
+    # @return [Array[ContributionEntity]]
+    attr_accessor :contribution
+
+    # Provides the past, present, and future vesting schedule and percentages
+    # @return [Array[VestingEntity]]
+    attr_accessor :vesting
+
+    # Investment loans in the account
+    # @return [Array[InvestmentLoanEntity]]
+    attr_accessor :investment_loans
+
+    # Cash balance across all sub-accounts. Should include sweep funds
+    # @return [Float]
+    attr_accessor :available_cash_balance
+
+    # Margin trading is allowed
+    # @return [TrueClass | FalseClass]
+    attr_accessor :margin
+
+    # Margin balance
+    # @return [Float]
+    attr_accessor :margin_balance
+
+    # Short balance
+    # @return [Float]
+    attr_accessor :short_balance
+
+    # Rollover amount
+    # @return [Float]
+    attr_accessor :rollover_amount
+
+    # Name of the employer in investment 401k Plan
+    # @return [String]
+    attr_accessor :employer_name
+
+    # Unique identifier FI
+    # @return [String]
+    attr_accessor :broker_id
+
+    # Plan number for Investment 401k plan
+    # @return [String]
+    attr_accessor :plan_id
+
+    # The calendar year for this 401k account
+    # @return [Integer]
+    attr_accessor :calendar_year_for401_k
+
+    # List of balances. Aggregate of name value pairs
+    # @return [Array[InvestmentBalanceEntity]]
+    attr_accessor :balance_list
+
+    # Daily change
+    # @return [Float]
+    attr_accessor :daily_change
+
+    # Percentage change
+    # @return [Float]
+    attr_accessor :percentage_change
+
+    # Transactions on the investment account
+    # @return [Array[InvestmentTransactionEntity]]
+    attr_accessor :transactions
+
+    # Pension sources in the investment account
+    # @return [Array[PensionSourceEntity]]
+    attr_accessor :pension_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['balance_as_of'] = 'balanceAsOf'
+      @_hash['allowed_check_writing'] = 'allowedCheckWriting'
+      @_hash['allowed_option_trade'] = 'allowedOptionTrade'
+      @_hash['current_value'] = 'currentValue'
+      @_hash['holdings'] = 'holdings'
+      @_hash['open_orders'] = 'openOrders'
+      @_hash['contribution'] = 'contribution'
+      @_hash['vesting'] = 'vesting'
+      @_hash['investment_loans'] = 'investmentLoans'
+      @_hash['available_cash_balance'] = 'availableCashBalance'
+      @_hash['margin'] = 'margin'
+      @_hash['margin_balance'] = 'marginBalance'
+      @_hash['short_balance'] = 'shortBalance'
+      @_hash['rollover_amount'] = 'rolloverAmount'
+      @_hash['employer_name'] = 'employerName'
+      @_hash['broker_id'] = 'brokerId'
+      @_hash['plan_id'] = 'planId'
+      @_hash['calendar_year_for401_k'] = 'calendarYearFor401K'
+      @_hash['balance_list'] = 'balanceList'
+      @_hash['daily_change'] = 'dailyChange'
+      @_hash['percentage_change'] = 'percentageChange'
+      @_hash['transactions'] = 'transactions'
+      @_hash['pension_source'] = 'pensionSource'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        balance_as_of
+        allowed_check_writing
+        allowed_option_trade
+        current_value
+        holdings
+        open_orders
+        contribution
+        vesting
+        investment_loans
+        available_cash_balance
+        margin
+        margin_balance
+        short_balance
+        rollover_amount
+        employer_name
+        broker_id
+        plan_id
+        calendar_year_for401_k
+        balance_list
+        daily_change
+        percentage_change
+        transactions
+        pension_source
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(balance_as_of: SKIP, allowed_check_writing: SKIP,
+                   allowed_option_trade: SKIP, current_value: SKIP,
+                   holdings: SKIP, open_orders: SKIP, contribution: SKIP,
+                   vesting: SKIP, investment_loans: SKIP,
+                   available_cash_balance: SKIP, margin: SKIP,
+                   margin_balance: SKIP, short_balance: SKIP,
+                   rollover_amount: SKIP, employer_name: SKIP, broker_id: SKIP,
+                   plan_id: SKIP, calendar_year_for401_k: SKIP,
+                   balance_list: SKIP, daily_change: SKIP,
+                   percentage_change: SKIP, transactions: SKIP,
+                   pension_source: SKIP, parent_account_id: SKIP,
+                   line_of_business: SKIP, routing_transit_number: SKIP,
+                   balance_type: SKIP, contact: SKIP, interest_rate: SKIP,
+                   interest_rate_type: SKIP, interest_rate_as_of: SKIP,
+                   prior_interest_rate: SKIP, interest_rate_index: SKIP,
+                   early_penalty_flag: SKIP, transfer_in: SKIP,
+                   transfer_out: SKIP, bill_pay_status: SKIP, micr_number: SKIP,
+                   last_activity_date: SKIP, reward_program_id: SKIP,
+                   transactions_included: SKIP, domicile: SKIP,
+                   account_category: 'Investment Account entity',
+                   account_id: SKIP, error: SKIP, account_type: SKIP,
+                   account_number: SKIP, account_number_display: SKIP,
+                   product_name: SKIP, nickname: SKIP, status: SKIP,
+                   description: SKIP, account_open_date: SKIP,
+                   account_close_date: SKIP, currency: SKIP,
+                   fi_attributes: SKIP, additional_properties: nil)
+      @balance_as_of = balance_as_of unless balance_as_of == SKIP
+      @allowed_check_writing = allowed_check_writing unless allowed_check_writing == SKIP
+      @allowed_option_trade = allowed_option_trade unless allowed_option_trade == SKIP
+      @current_value = current_value unless current_value == SKIP
+      @holdings = holdings unless holdings == SKIP
+      @open_orders = open_orders unless open_orders == SKIP
+      @contribution = contribution unless contribution == SKIP
+      @vesting = vesting unless vesting == SKIP
+      @investment_loans = investment_loans unless investment_loans == SKIP
+      @available_cash_balance = available_cash_balance unless available_cash_balance == SKIP
+      @margin = margin unless margin == SKIP
+      @margin_balance = margin_balance unless margin_balance == SKIP
+      @short_balance = short_balance unless short_balance == SKIP
+      @rollover_amount = rollover_amount unless rollover_amount == SKIP
+      @employer_name = employer_name unless employer_name == SKIP
+      @broker_id = broker_id unless broker_id == SKIP
+      @plan_id = plan_id unless plan_id == SKIP
+      @calendar_year_for401_k = calendar_year_for401_k unless calendar_year_for401_k == SKIP
+      @balance_list = balance_list unless balance_list == SKIP
+      @daily_change = daily_change unless daily_change == SKIP
+      @percentage_change = percentage_change unless percentage_change == SKIP
+      @transactions = transactions unless transactions == SKIP
+      @pension_source = pension_source unless pension_source == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(parent_account_id: parent_account_id,
+            line_of_business: line_of_business,
+            routing_transit_number: routing_transit_number,
+            balance_type: balance_type,
+            contact: contact,
+            interest_rate: interest_rate,
+            interest_rate_type: interest_rate_type,
+            interest_rate_as_of: interest_rate_as_of,
+            prior_interest_rate: prior_interest_rate,
+            interest_rate_index: interest_rate_index,
+            early_penalty_flag: early_penalty_flag,
+            transfer_in: transfer_in,
+            transfer_out: transfer_out,
+            bill_pay_status: bill_pay_status,
+            micr_number: micr_number,
+            last_activity_date: last_activity_date,
+            reward_program_id: reward_program_id,
+            transactions_included: transactions_included,
+            domicile: domicile,
+            account_category: account_category,
+            account_id: account_id,
+            error: error,
+            account_type: account_type,
+            account_number: account_number,
+            account_number_display: account_number_display,
+            product_name: product_name,
+            nickname: nickname,
+            status: status,
+            description: description,
+            account_open_date: account_open_date,
+            account_close_date: account_close_date,
+            currency: currency,
+            fi_attributes: fi_attributes,
+            additional_properties: additional_properties)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      balance_as_of = if hash.key?('balanceAsOf')
+                        (DateTimeHelper.from_rfc3339(hash['balanceAsOf']) if hash['balanceAsOf'])
+                      else
+                        SKIP
+                      end
+      allowed_check_writing =
+        hash.key?('allowedCheckWriting') ? hash['allowedCheckWriting'] : SKIP
+      allowed_option_trade =
+        hash.key?('allowedOptionTrade') ? hash['allowedOptionTrade'] : SKIP
+      current_value = hash.key?('currentValue') ? hash['currentValue'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      holdings = nil
+      unless hash['holdings'].nil?
+        holdings = []
+        hash['holdings'].each do |structure|
+          holdings << (HoldingEntity.from_hash(structure) if structure)
+        end
+      end
+
+      holdings = SKIP unless hash.key?('holdings')
+      # Parameter is an array, so we need to iterate through it
+      open_orders = nil
+      unless hash['openOrders'].nil?
+        open_orders = []
+        hash['openOrders'].each do |structure|
+          open_orders << (OpenOrderEntity.from_hash(structure) if structure)
+        end
+      end
+
+      open_orders = SKIP unless hash.key?('openOrders')
+      # Parameter is an array, so we need to iterate through it
+      contribution = nil
+      unless hash['contribution'].nil?
+        contribution = []
+        hash['contribution'].each do |structure|
+          contribution << (ContributionEntity.from_hash(structure) if structure)
+        end
+      end
+
+      contribution = SKIP unless hash.key?('contribution')
+      # Parameter is an array, so we need to iterate through it
+      vesting = nil
+      unless hash['vesting'].nil?
+        vesting = []
+        hash['vesting'].each do |structure|
+          vesting << (VestingEntity.from_hash(structure) if structure)
+        end
+      end
+
+      vesting = SKIP unless hash.key?('vesting')
+      # Parameter is an array, so we need to iterate through it
+      investment_loans = nil
+      unless hash['investmentLoans'].nil?
+        investment_loans = []
+        hash['investmentLoans'].each do |structure|
+          investment_loans << (InvestmentLoanEntity.from_hash(structure) if structure)
+        end
+      end
+
+      investment_loans = SKIP unless hash.key?('investmentLoans')
+      available_cash_balance =
+        hash.key?('availableCashBalance') ? hash['availableCashBalance'] : SKIP
+      margin = hash.key?('margin') ? hash['margin'] : SKIP
+      margin_balance = hash.key?('marginBalance') ? hash['marginBalance'] : SKIP
+      short_balance = hash.key?('shortBalance') ? hash['shortBalance'] : SKIP
+      rollover_amount =
+        hash.key?('rolloverAmount') ? hash['rolloverAmount'] : SKIP
+      employer_name = hash.key?('employerName') ? hash['employerName'] : SKIP
+      broker_id = hash.key?('brokerId') ? hash['brokerId'] : SKIP
+      plan_id = hash.key?('planId') ? hash['planId'] : SKIP
+      calendar_year_for401_k =
+        hash.key?('calendarYearFor401K') ? hash['calendarYearFor401K'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      balance_list = nil
+      unless hash['balanceList'].nil?
+        balance_list = []
+        hash['balanceList'].each do |structure|
+          balance_list << (InvestmentBalanceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      balance_list = SKIP unless hash.key?('balanceList')
+      daily_change = hash.key?('dailyChange') ? hash['dailyChange'] : SKIP
+      percentage_change =
+        hash.key?('percentageChange') ? hash['percentageChange'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (InvestmentTransactionEntity.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+      # Parameter is an array, so we need to iterate through it
+      pension_source = nil
+      unless hash['pensionSource'].nil?
+        pension_source = []
+        hash['pensionSource'].each do |structure|
+          pension_source << (PensionSourceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      pension_source = SKIP unless hash.key?('pensionSource')
+      parent_account_id =
+        hash.key?('parentAccountId') ? hash['parentAccountId'] : SKIP
+      line_of_business =
+        hash.key?('lineOfBusiness') ? hash['lineOfBusiness'] : SKIP
+      routing_transit_number =
+        hash.key?('routingTransitNumber') ? hash['routingTransitNumber'] : SKIP
+      balance_type = hash.key?('balanceType') ? hash['balanceType'] : SKIP
+      contact = AccountContactEntity2.from_hash(hash['contact']) if hash['contact']
+      interest_rate = hash.key?('interestRate') ? hash['interestRate'] : SKIP
+      interest_rate_type =
+        hash.key?('interestRateType') ? hash['interestRateType'] : SKIP
+      interest_rate_as_of = if hash.key?('interestRateAsOf')
+                              (DateTimeHelper.from_rfc3339(hash['interestRateAsOf']) if hash['interestRateAsOf'])
+                            else
+                              SKIP
+                            end
+      prior_interest_rate =
+        hash.key?('priorInterestRate') ? hash['priorInterestRate'] : SKIP
+      interest_rate_index =
+        hash.key?('interestRateIndex') ? hash['interestRateIndex'] : SKIP
+      early_penalty_flag =
+        hash.key?('earlyPenaltyFlag') ? hash['earlyPenaltyFlag'] : SKIP
+      transfer_in = hash.key?('transferIn') ? hash['transferIn'] : SKIP
+      transfer_out = hash.key?('transferOut') ? hash['transferOut'] : SKIP
+      bill_pay_status =
+        hash.key?('billPayStatus') ? hash['billPayStatus'] : SKIP
+      micr_number = hash.key?('micrNumber') ? hash['micrNumber'] : SKIP
+      last_activity_date =
+        hash.key?('lastActivityDate') ? hash['lastActivityDate'] : SKIP
+      reward_program_id =
+        hash.key?('rewardProgramId') ? hash['rewardProgramId'] : SKIP
+      transactions_included =
+        hash.key?('transactionsIncluded') ? hash['transactionsIncluded'] : SKIP
+      domicile = DomicileEntity1.from_hash(hash['domicile']) if hash['domicile']
+      account_category = hash['accountCategory'] ||= 'Investment Account entity'
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      error = Error1.from_hash(hash['error']) if hash['error']
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_number_display =
+        hash.key?('accountNumberDisplay') ? hash['accountNumberDisplay'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      nickname = hash.key?('nickname') ? hash['nickname'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      account_open_date =
+        hash.key?('accountOpenDate') ? hash['accountOpenDate'] : SKIP
+      account_close_date =
+        hash.key?('accountCloseDate') ? hash['accountCloseDate'] : SKIP
+      currency = CurrencyEntity4.from_hash(hash['currency']) if hash['currency']
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # 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.
+      InvestmentAccountEntity.new(balance_as_of: balance_as_of,
+                                  allowed_check_writing: allowed_check_writing,
+                                  allowed_option_trade: allowed_option_trade,
+                                  current_value: current_value,
+                                  holdings: holdings,
+                                  open_orders: open_orders,
+                                  contribution: contribution,
+                                  vesting: vesting,
+                                  investment_loans: investment_loans,
+                                  available_cash_balance: available_cash_balance,
+                                  margin: margin,
+                                  margin_balance: margin_balance,
+                                  short_balance: short_balance,
+                                  rollover_amount: rollover_amount,
+                                  employer_name: employer_name,
+                                  broker_id: broker_id,
+                                  plan_id: plan_id,
+                                  calendar_year_for401_k: calendar_year_for401_k,
+                                  balance_list: balance_list,
+                                  daily_change: daily_change,
+                                  percentage_change: percentage_change,
+                                  transactions: transactions,
+                                  pension_source: pension_source,
+                                  parent_account_id: parent_account_id,
+                                  line_of_business: line_of_business,
+                                  routing_transit_number: routing_transit_number,
+                                  balance_type: balance_type,
+                                  contact: contact,
+                                  interest_rate: interest_rate,
+                                  interest_rate_type: interest_rate_type,
+                                  interest_rate_as_of: interest_rate_as_of,
+                                  prior_interest_rate: prior_interest_rate,
+                                  interest_rate_index: interest_rate_index,
+                                  early_penalty_flag: early_penalty_flag,
+                                  transfer_in: transfer_in,
+                                  transfer_out: transfer_out,
+                                  bill_pay_status: bill_pay_status,
+                                  micr_number: micr_number,
+                                  last_activity_date: last_activity_date,
+                                  reward_program_id: reward_program_id,
+                                  transactions_included: transactions_included,
+                                  domicile: domicile,
+                                  account_category: account_category,
+                                  account_id: account_id,
+                                  error: error,
+                                  account_type: account_type,
+                                  account_number: account_number,
+                                  account_number_display: account_number_display,
+                                  product_name: product_name,
+                                  nickname: nickname,
+                                  status: status,
+                                  description: description,
+                                  account_open_date: account_open_date,
+                                  account_close_date: account_close_date,
+                                  currency: currency,
+                                  fi_attributes: fi_attributes,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_balance_as_of
+      DateTimeHelper.to_rfc3339(balance_as_of)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvestmentAccountEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, balance_as_of: #{@balance_as_of}, allowed_check_writing:"\
+      " #{@allowed_check_writing}, allowed_option_trade: #{@allowed_option_trade}, current_value:"\
+      " #{@current_value}, holdings: #{@holdings}, open_orders: #{@open_orders}, contribution:"\
+      " #{@contribution}, vesting: #{@vesting}, investment_loans: #{@investment_loans},"\
+      " available_cash_balance: #{@available_cash_balance}, margin: #{@margin}, margin_balance:"\
+      " #{@margin_balance}, short_balance: #{@short_balance}, rollover_amount:"\
+      " #{@rollover_amount}, employer_name: #{@employer_name}, broker_id: #{@broker_id}, plan_id:"\
+      " #{@plan_id}, calendar_year_for401_k: #{@calendar_year_for401_k}, balance_list:"\
+      " #{@balance_list}, daily_change: #{@daily_change}, percentage_change:"\
+      " #{@percentage_change}, transactions: #{@transactions}, pension_source:"\
+      " #{@pension_source}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, balance_as_of: #{@balance_as_of.inspect},"\
+      " allowed_check_writing: #{@allowed_check_writing.inspect}, allowed_option_trade:"\
+      " #{@allowed_option_trade.inspect}, current_value: #{@current_value.inspect}, holdings:"\
+      " #{@holdings.inspect}, open_orders: #{@open_orders.inspect}, contribution:"\
+      " #{@contribution.inspect}, vesting: #{@vesting.inspect}, investment_loans:"\
+      " #{@investment_loans.inspect}, available_cash_balance: #{@available_cash_balance.inspect},"\
+      " margin: #{@margin.inspect}, margin_balance: #{@margin_balance.inspect}, short_balance:"\
+      " #{@short_balance.inspect}, rollover_amount: #{@rollover_amount.inspect}, employer_name:"\
+      " #{@employer_name.inspect}, broker_id: #{@broker_id.inspect}, plan_id: #{@plan_id.inspect},"\
+      " calendar_year_for401_k: #{@calendar_year_for401_k.inspect}, balance_list:"\
+      " #{@balance_list.inspect}, daily_change: #{@daily_change.inspect}, percentage_change:"\
+      " #{@percentage_change.inspect}, transactions: #{@transactions.inspect}, pension_source:"\
+      " #{@pension_source.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/investment_balance_entity.rb

@@ -0,0 +1,138 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A point-in-time balance of the investment account
+  class InvestmentBalanceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the balance
+    # @return [String]
+    attr_accessor :balance_name
+
+    # Description of balance
+    # @return [String]
+    attr_accessor :balance_description
+
+    # AMOUNT, PERCENTAGE
+    # @return [InvestmentBalanceType2]
+    attr_accessor :balance_type
+
+    # Value of named balance
+    # @return [Float]
+    attr_accessor :balance_value
+
+    # Date as of this balance
+    # @return [Date]
+    attr_accessor :balance_date
+
+    # Currency if different from that of account
+    # @return [CurrencyEntity2]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['balance_name'] = 'balanceName'
+      @_hash['balance_description'] = 'balanceDescription'
+      @_hash['balance_type'] = 'balanceType'
+      @_hash['balance_value'] = 'balanceValue'
+      @_hash['balance_date'] = 'balanceDate'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        balance_name
+        balance_description
+        balance_type
+        balance_value
+        balance_date
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(balance_name: SKIP, balance_description: SKIP,
+                   balance_type: SKIP, balance_value: SKIP, balance_date: SKIP,
+                   currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @balance_name = balance_name unless balance_name == SKIP
+      @balance_description = balance_description unless balance_description == SKIP
+      @balance_type = balance_type unless balance_type == SKIP
+      @balance_value = balance_value unless balance_value == SKIP
+      @balance_date = balance_date unless balance_date == SKIP
+      @currency = currency unless currency == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      balance_name = hash.key?('balanceName') ? hash['balanceName'] : SKIP
+      balance_description =
+        hash.key?('balanceDescription') ? hash['balanceDescription'] : SKIP
+      balance_type = hash.key?('balanceType') ? hash['balanceType'] : SKIP
+      balance_value = hash.key?('balanceValue') ? hash['balanceValue'] : SKIP
+      balance_date = hash.key?('balanceDate') ? hash['balanceDate'] : SKIP
+      currency = CurrencyEntity2.from_hash(hash['currency']) if hash['currency']
+
+      # 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.
+      InvestmentBalanceEntity.new(balance_name: balance_name,
+                                  balance_description: balance_description,
+                                  balance_type: balance_type,
+                                  balance_value: balance_value,
+                                  balance_date: balance_date,
+                                  currency: currency,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvestmentBalanceEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balance_name: #{@balance_name}, balance_description:"\
+      " #{@balance_description}, balance_type: #{@balance_type}, balance_value: #{@balance_value},"\
+      " balance_date: #{@balance_date}, currency: #{@currency}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balance_name: #{@balance_name.inspect}, balance_description:"\
+      " #{@balance_description.inspect}, balance_type: #{@balance_type.inspect}, balance_value:"\
+      " #{@balance_value.inspect}, balance_date: #{@balance_date.inspect}, currency:"\
+      " #{@currency.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end