fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/investment_transaction_entity.rb

@@ -0,0 +1,669 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'transaction'
+
+module FdxApi
+  # Specific transaction information
+  class InvestmentTransactionEntity < Transaction
+    # PURCHASED, SOLD, PURCHASEDTOCOVER, ADJUSTMENT, PURCHASETOOPEN,
+    # PURCHASETOCLOSE, SOLDTOOPEN, SOLDTOCLOSE, INTEREST, MARGININTEREST,
+    # REINVESTOFINCOME, RETURNOFCAPITAL, TRANSFER, CONTRIBUTION, FEE,
+    # OPTIONEXERCISE, OPTIONEXPIRATION, DIVIDEND, DIVIDENDREINVEST, SPLIT,
+    # CLOSURE, INCOME, EXPENSE, CLOSUREOPT, INVEXPENSE, JRNLSEC, JRNLFUND,
+    # OTHER, DIV, SRVCHG, DEP, DEPOSIT, ATM, POS, XFER, CHECK, PAYMENT, CASH,
+    # DIRECTDEP, DIRECTDEBIT, REPEATPMT
+    # @return [InvestmentTransactionType2]
+    attr_accessor :transaction_type
+
+    # Required for stock, mutual funds. Number of shares (with decimals).
+    # Negative numbers indicate securities are being removed from the account
+    # @return [Float]
+    attr_accessor :shares
+
+    # Cash value for bonds
+    # @return [Float]
+    attr_accessor :face_value
+
+    # Unit purchase price
+    # @return [Float]
+    attr_accessor :price
+
+    # Unique identifier of security
+    # @return [String]
+    attr_accessor :security_id
+
+    # CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN
+    # @return [SecurityIdType1]
+    attr_accessor :security_id_type
+
+    # BOND, DEBT, DIGITALASSET, MUTUALFUND, OPTION, OTHER, STOCK, SWEEP
+    # @return [SecurityType2]
+    attr_accessor :security_type
+
+    # Ticker symbol
+    # @return [String]
+    attr_accessor :symbol
+
+    # Portion of unit price that is attributed to the dealer markup
+    # @return [Float]
+    attr_accessor :markup
+
+    # Transaction commission
+    # @return [Float]
+    attr_accessor :commission
+
+    # Taxes on the trade
+    # @return [Float]
+    attr_accessor :taxes
+
+    # Fees applied to the trade
+    # @return [Float]
+    attr_accessor :fees
+
+    # Load on the transaction
+    # @return [Float]
+    attr_accessor :load
+
+    # Source of money. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER,
+    # OTHERVEST, OTHERNONVEST
+    # @return [Investment401KSourceType2]
+    attr_accessor :inv401k_source
+
+    # Confirmation number of the transaction
+    # @return [String]
+    attr_accessor :confirmation_number
+
+    # Cash for fractional units (used for stock splits)
+    # @return [Float]
+    attr_accessor :fractional_cash
+
+    # Type of investment income. One of CGLONG (capital gains-long term),
+    # CGSHORT (capital gains-short term), MISC
+    # @return [IncomeType2]
+    attr_accessor :income_type
+
+    # Number of shares before split
+    # @return [Float]
+    attr_accessor :old_units
+
+    # Split ratio numerator
+    # @return [Float]
+    attr_accessor :split_ratio_numerator
+
+    # Split ratio denominator
+    # @return [Float]
+    attr_accessor :split_ratio_denominator
+
+    # Number of shares after split
+    # @return [Float]
+    attr_accessor :new_units
+
+    # Sub-account security Type. One of CASH, MARGIN, SHORT, OTHERS
+    # @return [SubAccountType1]
+    attr_accessor :sub_account_sec
+
+    # From which account money came in. One of CASH, MARGIN, SHORT, OTHERS
+    # @return [SubAccountType2]
+    attr_accessor :sub_account_fund
+
+    # For 401k accounts only. This indicates the transaction was due to a loan
+    # or a loan repayment
+    # @return [String]
+    attr_accessor :loan_id
+
+    # How much loan pre-payment is principal
+    # @return [Float]
+    attr_accessor :loan_principal
+
+    # How much loan pre-payment is interest
+    # @return [Float]
+    attr_accessor :loan_interest
+
+    # The date for the 401k transaction was obtained in payroll
+    # @return [Date]
+    attr_accessor :payroll_date
+
+    # Indicates this buy was made using prior year's contribution
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prior_year_contrib
+
+    # Federal tax withholding
+    # @return [Float]
+    attr_accessor :withholding
+
+    # Tax-exempt transaction
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # For sales
+    # @return [Float]
+    attr_accessor :gain
+
+    # State tax withholding
+    # @return [Float]
+    attr_accessor :state_withholding
+
+    # Indicates amount withheld due to a penalty
+    # @return [Float]
+    attr_accessor :penalty
+
+    # Running balance of the position
+    # @return [Float]
+    attr_accessor :running_balance
+
+    # Price per commonly-quoted unit. Does not include markup/markdown,
+    # unitprice. Share price for stocks, mutual funds, and others. Percentage of
+    # par for bonds. Per share (not contract) for options
+    # @return [Float]
+    attr_accessor :unit_price
+
+    # For security-based actions other than stock splits, quantity. Shares for
+    # stocks, mutual funds, and others. Face value for bonds. Contracts for
+    # options
+    # @return [Float]
+    attr_accessor :units
+
+    # SHARES, CURRENCY
+    # @return [UnitType1]
+    attr_accessor :unit_type
+
+    # Reason for this transaction; CALL (the debt was called), SELL (the debt
+    # was sold), MATURITY (the debt reached maturity)
+    # @return [TransactionReason2]
+    attr_accessor :transaction_reason
+
+    # Accrued interest
+    # @return [Float]
+    attr_accessor :accrued_interest
+
+    # Transfer direction
+    # @return [InvestmentTransferActionDirection2]
+    attr_accessor :transfer_action
+
+    # LONG, SHORT
+    # @return [PositionType1]
+    attr_accessor :position_type
+
+    # Full precision unit number, unlimited digits after decimal point
+    # @return [String]
+    attr_accessor :digital_units
+
+    # When the trade settled
+    # @return [DateTime]
+    attr_accessor :settlement_timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash['shares'] = 'shares'
+      @_hash['face_value'] = 'faceValue'
+      @_hash['price'] = 'price'
+      @_hash['security_id'] = 'securityId'
+      @_hash['security_id_type'] = 'securityIdType'
+      @_hash['security_type'] = 'securityType'
+      @_hash['symbol'] = 'symbol'
+      @_hash['markup'] = 'markup'
+      @_hash['commission'] = 'commission'
+      @_hash['taxes'] = 'taxes'
+      @_hash['fees'] = 'fees'
+      @_hash['load'] = 'load'
+      @_hash['inv401k_source'] = 'inv401kSource'
+      @_hash['confirmation_number'] = 'confirmationNumber'
+      @_hash['fractional_cash'] = 'fractionalCash'
+      @_hash['income_type'] = 'incomeType'
+      @_hash['old_units'] = 'oldUnits'
+      @_hash['split_ratio_numerator'] = 'splitRatioNumerator'
+      @_hash['split_ratio_denominator'] = 'splitRatioDenominator'
+      @_hash['new_units'] = 'newUnits'
+      @_hash['sub_account_sec'] = 'subAccountSec'
+      @_hash['sub_account_fund'] = 'subAccountFund'
+      @_hash['loan_id'] = 'loanId'
+      @_hash['loan_principal'] = 'loanPrincipal'
+      @_hash['loan_interest'] = 'loanInterest'
+      @_hash['payroll_date'] = 'payrollDate'
+      @_hash['prior_year_contrib'] = 'priorYearContrib'
+      @_hash['withholding'] = 'withholding'
+      @_hash['tax_exempt'] = 'taxExempt'
+      @_hash['gain'] = 'gain'
+      @_hash['state_withholding'] = 'stateWithholding'
+      @_hash['penalty'] = 'penalty'
+      @_hash['running_balance'] = 'runningBalance'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['units'] = 'units'
+      @_hash['unit_type'] = 'unitType'
+      @_hash['transaction_reason'] = 'transactionReason'
+      @_hash['accrued_interest'] = 'accruedInterest'
+      @_hash['transfer_action'] = 'transferAction'
+      @_hash['position_type'] = 'positionType'
+      @_hash['digital_units'] = 'digitalUnits'
+      @_hash['settlement_timestamp'] = 'settlementTimestamp'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        transaction_type
+        shares
+        face_value
+        price
+        security_id
+        security_id_type
+        security_type
+        symbol
+        markup
+        commission
+        taxes
+        fees
+        load
+        inv401k_source
+        confirmation_number
+        fractional_cash
+        income_type
+        old_units
+        split_ratio_numerator
+        split_ratio_denominator
+        new_units
+        sub_account_sec
+        sub_account_fund
+        loan_id
+        loan_principal
+        loan_interest
+        payroll_date
+        prior_year_contrib
+        withholding
+        tax_exempt
+        gain
+        state_withholding
+        penalty
+        running_balance
+        unit_price
+        units
+        unit_type
+        transaction_reason
+        accrued_interest
+        transfer_action
+        position_type
+        digital_units
+        settlement_timestamp
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(transaction_type: SKIP, shares: SKIP, face_value: SKIP,
+                   price: SKIP, security_id: SKIP, security_id_type: SKIP,
+                   security_type: SKIP, symbol: SKIP, markup: SKIP,
+                   commission: SKIP, taxes: SKIP, fees: SKIP, load: SKIP,
+                   inv401k_source: SKIP, confirmation_number: SKIP,
+                   fractional_cash: SKIP, income_type: SKIP, old_units: SKIP,
+                   split_ratio_numerator: SKIP, split_ratio_denominator: SKIP,
+                   new_units: SKIP, sub_account_sec: SKIP,
+                   sub_account_fund: SKIP, loan_id: SKIP, loan_principal: SKIP,
+                   loan_interest: SKIP, payroll_date: SKIP,
+                   prior_year_contrib: SKIP, withholding: SKIP,
+                   tax_exempt: SKIP, gain: SKIP, state_withholding: SKIP,
+                   penalty: SKIP, running_balance: SKIP, unit_price: SKIP,
+                   units: SKIP, unit_type: SKIP, transaction_reason: SKIP,
+                   accrued_interest: SKIP, transfer_action: SKIP,
+                   position_type: SKIP, digital_units: SKIP,
+                   settlement_timestamp: SKIP,
+                   account_category: 'Investment Transaction entity',
+                   account_id: SKIP, transaction_id: SKIP,
+                   reference_transaction_id: SKIP, posted_timestamp: SKIP,
+                   transaction_timestamp: SKIP, description: SKIP, memo: SKIP,
+                   debit_credit_memo: SKIP, category: SKIP, sub_category: SKIP,
+                   reference: SKIP, status: SKIP, amount: SKIP,
+                   foreign_amount: SKIP, foreign_currency: SKIP,
+                   image_ids: SKIP, line_item: SKIP, reward: SKIP,
+                   fi_attributes: SKIP, links: SKIP, additional_properties: nil)
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @shares = shares unless shares == SKIP
+      @face_value = face_value unless face_value == SKIP
+      @price = price unless price == SKIP
+      @security_id = security_id unless security_id == SKIP
+      @security_id_type = security_id_type unless security_id_type == SKIP
+      @security_type = security_type unless security_type == SKIP
+      @symbol = symbol unless symbol == SKIP
+      @markup = markup unless markup == SKIP
+      @commission = commission unless commission == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @fees = fees unless fees == SKIP
+      @load = load unless load == SKIP
+      @inv401k_source = inv401k_source unless inv401k_source == SKIP
+      @confirmation_number = confirmation_number unless confirmation_number == SKIP
+      @fractional_cash = fractional_cash unless fractional_cash == SKIP
+      @income_type = income_type unless income_type == SKIP
+      @old_units = old_units unless old_units == SKIP
+      @split_ratio_numerator = split_ratio_numerator unless split_ratio_numerator == SKIP
+      @split_ratio_denominator = split_ratio_denominator unless split_ratio_denominator == SKIP
+      @new_units = new_units unless new_units == SKIP
+      @sub_account_sec = sub_account_sec unless sub_account_sec == SKIP
+      @sub_account_fund = sub_account_fund unless sub_account_fund == SKIP
+      @loan_id = loan_id unless loan_id == SKIP
+      @loan_principal = loan_principal unless loan_principal == SKIP
+      @loan_interest = loan_interest unless loan_interest == SKIP
+      @payroll_date = payroll_date unless payroll_date == SKIP
+      @prior_year_contrib = prior_year_contrib unless prior_year_contrib == SKIP
+      @withholding = withholding unless withholding == SKIP
+      @tax_exempt = tax_exempt unless tax_exempt == SKIP
+      @gain = gain unless gain == SKIP
+      @state_withholding = state_withholding unless state_withholding == SKIP
+      @penalty = penalty unless penalty == SKIP
+      @running_balance = running_balance unless running_balance == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @units = units unless units == SKIP
+      @unit_type = unit_type unless unit_type == SKIP
+      @transaction_reason = transaction_reason unless transaction_reason == SKIP
+      @accrued_interest = accrued_interest unless accrued_interest == SKIP
+      @transfer_action = transfer_action unless transfer_action == SKIP
+      @position_type = position_type unless position_type == SKIP
+      @digital_units = digital_units unless digital_units == SKIP
+      @settlement_timestamp = settlement_timestamp unless settlement_timestamp == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(account_category: account_category,
+            account_id: account_id,
+            transaction_id: transaction_id,
+            reference_transaction_id: reference_transaction_id,
+            posted_timestamp: posted_timestamp,
+            transaction_timestamp: transaction_timestamp,
+            description: description,
+            memo: memo,
+            debit_credit_memo: debit_credit_memo,
+            category: category,
+            sub_category: sub_category,
+            reference: reference,
+            status: status,
+            amount: amount,
+            foreign_amount: foreign_amount,
+            foreign_currency: foreign_currency,
+            image_ids: image_ids,
+            line_item: line_item,
+            reward: reward,
+            fi_attributes: fi_attributes,
+            links: links,
+            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.
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : SKIP
+      shares = hash.key?('shares') ? hash['shares'] : SKIP
+      face_value = hash.key?('faceValue') ? hash['faceValue'] : SKIP
+      price = hash.key?('price') ? hash['price'] : SKIP
+      security_id = hash.key?('securityId') ? hash['securityId'] : SKIP
+      security_id_type =
+        hash.key?('securityIdType') ? hash['securityIdType'] : SKIP
+      security_type = hash.key?('securityType') ? hash['securityType'] : SKIP
+      symbol = hash.key?('symbol') ? hash['symbol'] : SKIP
+      markup = hash.key?('markup') ? hash['markup'] : SKIP
+      commission = hash.key?('commission') ? hash['commission'] : SKIP
+      taxes = hash.key?('taxes') ? hash['taxes'] : SKIP
+      fees = hash.key?('fees') ? hash['fees'] : SKIP
+      load = hash.key?('load') ? hash['load'] : SKIP
+      inv401k_source = hash.key?('inv401kSource') ? hash['inv401kSource'] : SKIP
+      confirmation_number =
+        hash.key?('confirmationNumber') ? hash['confirmationNumber'] : SKIP
+      fractional_cash =
+        hash.key?('fractionalCash') ? hash['fractionalCash'] : SKIP
+      income_type = hash.key?('incomeType') ? hash['incomeType'] : SKIP
+      old_units = hash.key?('oldUnits') ? hash['oldUnits'] : SKIP
+      split_ratio_numerator =
+        hash.key?('splitRatioNumerator') ? hash['splitRatioNumerator'] : SKIP
+      split_ratio_denominator =
+        hash.key?('splitRatioDenominator') ? hash['splitRatioDenominator'] : SKIP
+      new_units = hash.key?('newUnits') ? hash['newUnits'] : SKIP
+      sub_account_sec =
+        hash.key?('subAccountSec') ? hash['subAccountSec'] : SKIP
+      sub_account_fund =
+        hash.key?('subAccountFund') ? hash['subAccountFund'] : SKIP
+      loan_id = hash.key?('loanId') ? hash['loanId'] : SKIP
+      loan_principal = hash.key?('loanPrincipal') ? hash['loanPrincipal'] : SKIP
+      loan_interest = hash.key?('loanInterest') ? hash['loanInterest'] : SKIP
+      payroll_date = hash.key?('payrollDate') ? hash['payrollDate'] : SKIP
+      prior_year_contrib =
+        hash.key?('priorYearContrib') ? hash['priorYearContrib'] : SKIP
+      withholding = hash.key?('withholding') ? hash['withholding'] : SKIP
+      tax_exempt = hash.key?('taxExempt') ? hash['taxExempt'] : SKIP
+      gain = hash.key?('gain') ? hash['gain'] : SKIP
+      state_withholding =
+        hash.key?('stateWithholding') ? hash['stateWithholding'] : SKIP
+      penalty = hash.key?('penalty') ? hash['penalty'] : SKIP
+      running_balance =
+        hash.key?('runningBalance') ? hash['runningBalance'] : SKIP
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+      units = hash.key?('units') ? hash['units'] : SKIP
+      unit_type = hash.key?('unitType') ? hash['unitType'] : SKIP
+      transaction_reason =
+        hash.key?('transactionReason') ? hash['transactionReason'] : SKIP
+      accrued_interest =
+        hash.key?('accruedInterest') ? hash['accruedInterest'] : SKIP
+      transfer_action =
+        hash.key?('transferAction') ? hash['transferAction'] : SKIP
+      position_type = hash.key?('positionType') ? hash['positionType'] : SKIP
+      digital_units = hash.key?('digitalUnits') ? hash['digitalUnits'] : SKIP
+      settlement_timestamp = if hash.key?('settlementTimestamp')
+                               (DateTimeHelper.from_rfc3339(hash['settlementTimestamp']) if hash['settlementTimestamp'])
+                             else
+                               SKIP
+                             end
+      account_category =
+        hash['accountCategory'] ||= 'Investment Transaction entity'
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      reference_transaction_id =
+        hash.key?('referenceTransactionId') ? hash['referenceTransactionId'] : SKIP
+      posted_timestamp = if hash.key?('postedTimestamp')
+                           (DateTimeHelper.from_rfc3339(hash['postedTimestamp']) if hash['postedTimestamp'])
+                         else
+                           SKIP
+                         end
+      transaction_timestamp = if hash.key?('transactionTimestamp')
+                                (DateTimeHelper.from_rfc3339(hash['transactionTimestamp']) if hash['transactionTimestamp'])
+                              else
+                                SKIP
+                              end
+      description = hash.key?('description') ? hash['description'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      debit_credit_memo =
+        hash.key?('debitCreditMemo') ? hash['debitCreditMemo'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      sub_category = hash.key?('subCategory') ? hash['subCategory'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      foreign_amount = hash.key?('foreignAmount') ? hash['foreignAmount'] : SKIP
+      foreign_currency =
+        hash.key?('foreignCurrency') ? hash['foreignCurrency'] : SKIP
+      image_ids = hash.key?('imageIds') ? hash['imageIds'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_item = nil
+      unless hash['lineItem'].nil?
+        line_item = []
+        hash['lineItem'].each do |structure|
+          line_item << (LineItemEntity.from_hash(structure) if structure)
+        end
+      end
+
+      line_item = SKIP unless hash.key?('lineItem')
+      reward = TransactionRewardEntity2.from_hash(hash['reward']) if hash['reward']
+      # 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')
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+
+      # 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.
+      InvestmentTransactionEntity.new(transaction_type: transaction_type,
+                                      shares: shares,
+                                      face_value: face_value,
+                                      price: price,
+                                      security_id: security_id,
+                                      security_id_type: security_id_type,
+                                      security_type: security_type,
+                                      symbol: symbol,
+                                      markup: markup,
+                                      commission: commission,
+                                      taxes: taxes,
+                                      fees: fees,
+                                      load: load,
+                                      inv401k_source: inv401k_source,
+                                      confirmation_number: confirmation_number,
+                                      fractional_cash: fractional_cash,
+                                      income_type: income_type,
+                                      old_units: old_units,
+                                      split_ratio_numerator: split_ratio_numerator,
+                                      split_ratio_denominator: split_ratio_denominator,
+                                      new_units: new_units,
+                                      sub_account_sec: sub_account_sec,
+                                      sub_account_fund: sub_account_fund,
+                                      loan_id: loan_id,
+                                      loan_principal: loan_principal,
+                                      loan_interest: loan_interest,
+                                      payroll_date: payroll_date,
+                                      prior_year_contrib: prior_year_contrib,
+                                      withholding: withholding,
+                                      tax_exempt: tax_exempt,
+                                      gain: gain,
+                                      state_withholding: state_withholding,
+                                      penalty: penalty,
+                                      running_balance: running_balance,
+                                      unit_price: unit_price,
+                                      units: units,
+                                      unit_type: unit_type,
+                                      transaction_reason: transaction_reason,
+                                      accrued_interest: accrued_interest,
+                                      transfer_action: transfer_action,
+                                      position_type: position_type,
+                                      digital_units: digital_units,
+                                      settlement_timestamp: settlement_timestamp,
+                                      account_category: account_category,
+                                      account_id: account_id,
+                                      transaction_id: transaction_id,
+                                      reference_transaction_id: reference_transaction_id,
+                                      posted_timestamp: posted_timestamp,
+                                      transaction_timestamp: transaction_timestamp,
+                                      description: description,
+                                      memo: memo,
+                                      debit_credit_memo: debit_credit_memo,
+                                      category: category,
+                                      sub_category: sub_category,
+                                      reference: reference,
+                                      status: status,
+                                      amount: amount,
+                                      foreign_amount: foreign_amount,
+                                      foreign_currency: foreign_currency,
+                                      image_ids: image_ids,
+                                      line_item: line_item,
+                                      reward: reward,
+                                      fi_attributes: fi_attributes,
+                                      links: links,
+                                      additional_properties: additional_properties)
+    end
+
+    def to_custom_settlement_timestamp
+      DateTimeHelper.to_rfc3339(settlement_timestamp)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvestmentTransactionEntity | 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}, transaction_type: #{@transaction_type}, shares:"\
+      " #{@shares}, face_value: #{@face_value}, price: #{@price}, security_id: #{@security_id},"\
+      " security_id_type: #{@security_id_type}, security_type: #{@security_type}, symbol:"\
+      " #{@symbol}, markup: #{@markup}, commission: #{@commission}, taxes: #{@taxes}, fees:"\
+      " #{@fees}, load: #{@load}, inv401k_source: #{@inv401k_source}, confirmation_number:"\
+      " #{@confirmation_number}, fractional_cash: #{@fractional_cash}, income_type:"\
+      " #{@income_type}, old_units: #{@old_units}, split_ratio_numerator:"\
+      " #{@split_ratio_numerator}, split_ratio_denominator: #{@split_ratio_denominator},"\
+      " new_units: #{@new_units}, sub_account_sec: #{@sub_account_sec}, sub_account_fund:"\
+      " #{@sub_account_fund}, loan_id: #{@loan_id}, loan_principal: #{@loan_principal},"\
+      " loan_interest: #{@loan_interest}, payroll_date: #{@payroll_date}, prior_year_contrib:"\
+      " #{@prior_year_contrib}, withholding: #{@withholding}, tax_exempt: #{@tax_exempt}, gain:"\
+      " #{@gain}, state_withholding: #{@state_withholding}, penalty: #{@penalty}, running_balance:"\
+      " #{@running_balance}, unit_price: #{@unit_price}, units: #{@units}, unit_type:"\
+      " #{@unit_type}, transaction_reason: #{@transaction_reason}, accrued_interest:"\
+      " #{@accrued_interest}, transfer_action: #{@transfer_action}, position_type:"\
+      " #{@position_type}, digital_units: #{@digital_units}, settlement_timestamp:"\
+      " #{@settlement_timestamp}>"
+    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}, transaction_type: #{@transaction_type.inspect}, shares:"\
+      " #{@shares.inspect}, face_value: #{@face_value.inspect}, price: #{@price.inspect},"\
+      " security_id: #{@security_id.inspect}, security_id_type: #{@security_id_type.inspect},"\
+      " security_type: #{@security_type.inspect}, symbol: #{@symbol.inspect}, markup:"\
+      " #{@markup.inspect}, commission: #{@commission.inspect}, taxes: #{@taxes.inspect}, fees:"\
+      " #{@fees.inspect}, load: #{@load.inspect}, inv401k_source: #{@inv401k_source.inspect},"\
+      " confirmation_number: #{@confirmation_number.inspect}, fractional_cash:"\
+      " #{@fractional_cash.inspect}, income_type: #{@income_type.inspect}, old_units:"\
+      " #{@old_units.inspect}, split_ratio_numerator: #{@split_ratio_numerator.inspect},"\
+      " split_ratio_denominator: #{@split_ratio_denominator.inspect}, new_units:"\
+      " #{@new_units.inspect}, sub_account_sec: #{@sub_account_sec.inspect}, sub_account_fund:"\
+      " #{@sub_account_fund.inspect}, loan_id: #{@loan_id.inspect}, loan_principal:"\
+      " #{@loan_principal.inspect}, loan_interest: #{@loan_interest.inspect}, payroll_date:"\
+      " #{@payroll_date.inspect}, prior_year_contrib: #{@prior_year_contrib.inspect}, withholding:"\
+      " #{@withholding.inspect}, tax_exempt: #{@tax_exempt.inspect}, gain: #{@gain.inspect},"\
+      " state_withholding: #{@state_withholding.inspect}, penalty: #{@penalty.inspect},"\
+      " running_balance: #{@running_balance.inspect}, unit_price: #{@unit_price.inspect}, units:"\
+      " #{@units.inspect}, unit_type: #{@unit_type.inspect}, transaction_reason:"\
+      " #{@transaction_reason.inspect}, accrued_interest: #{@accrued_interest.inspect},"\
+      " transfer_action: #{@transfer_action.inspect}, position_type: #{@position_type.inspect},"\
+      " digital_units: #{@digital_units.inspect}, settlement_timestamp:"\
+      " #{@settlement_timestamp.inspect}>"
+    end
+  end
+end