fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/code_and_amount.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Code and amount pair used on IRS W-2, K-1, etc.
+  class CodeAndAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code
+    # @return [String]
+    attr_accessor :code
+
+    # Amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, amount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @amount = amount unless amount == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+
+      # 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.
+      CodeAndAmount.new(code: code,
+                        amount: amount,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, amount: #{@amount}, 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} code: #{@code.inspect}, amount: #{@amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/commercial_account_entity.rb

@@ -0,0 +1,457 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'account_entity'
+
+module FdxApi
+  # Information for a commercial account type
+  class CommercialAccountEntity < AccountEntity
+    # As-of date of balances
+    # @return [DateTime]
+    attr_accessor :balance_as_of
+
+    # Opening ledger balance
+    # @return [Float]
+    attr_accessor :opening_ledger_balance
+
+    # Closing ledger balance
+    # @return [Float]
+    attr_accessor :closing_ledger_balance
+
+    # Current ledger balance
+    # @return [Float]
+    attr_accessor :current_ledger_balance
+
+    # Opening available balance
+    # @return [Float]
+    attr_accessor :opening_available_balance
+
+    # Current available balance
+    # @return [Float]
+    attr_accessor :current_available_balance
+
+    # Closing available balance
+    # @return [Float]
+    attr_accessor :closing_available_balance
+
+    # Next day's available balance
+    # @return [Float]
+    attr_accessor :next_day_available_balance
+
+    # Two days out's available balance
+    # @return [Float]
+    attr_accessor :two_days_plus_available_balance
+
+    # Number of outstanding credit transactions
+    # @return [Integer]
+    attr_accessor :number_of_outstanding_credits
+
+    # Total amount of outstanding credits
+    # @return [Float]
+    attr_accessor :outstanding_credits_amount
+
+    # Number of outstanding debit transactions
+    # @return [Integer]
+    attr_accessor :number_of_outstanding_debits
+
+    # Total amount of outstanding debits
+    # @return [Float]
+    attr_accessor :outstanding_debits_amount
+
+    # Transactions on the commercial account
+    # @return [Array[CommercialTransactionEntity]]
+    attr_accessor :transactions
+
+    # A list of specific treasury management defined balances
+    # @return [Array[CommercialBalanceEntity]]
+    attr_accessor :commercial_balances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['balance_as_of'] = 'balanceAsOf'
+      @_hash['opening_ledger_balance'] = 'openingLedgerBalance'
+      @_hash['closing_ledger_balance'] = 'closingLedgerBalance'
+      @_hash['current_ledger_balance'] = 'currentLedgerBalance'
+      @_hash['opening_available_balance'] = 'openingAvailableBalance'
+      @_hash['current_available_balance'] = 'currentAvailableBalance'
+      @_hash['closing_available_balance'] = 'closingAvailableBalance'
+      @_hash['next_day_available_balance'] = 'nextDayAvailableBalance'
+      @_hash['two_days_plus_available_balance'] =
+        'twoDaysPlusAvailableBalance'
+      @_hash['number_of_outstanding_credits'] = 'numberOfOutstandingCredits'
+      @_hash['outstanding_credits_amount'] = 'outstandingCreditsAmount'
+      @_hash['number_of_outstanding_debits'] = 'numberOfOutstandingDebits'
+      @_hash['outstanding_debits_amount'] = 'outstandingDebitsAmount'
+      @_hash['transactions'] = 'transactions'
+      @_hash['commercial_balances'] = 'commercialBalances'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        balance_as_of
+        opening_ledger_balance
+        closing_ledger_balance
+        current_ledger_balance
+        opening_available_balance
+        current_available_balance
+        closing_available_balance
+        next_day_available_balance
+        two_days_plus_available_balance
+        number_of_outstanding_credits
+        outstanding_credits_amount
+        number_of_outstanding_debits
+        outstanding_debits_amount
+        transactions
+        commercial_balances
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(balance_as_of: SKIP, opening_ledger_balance: SKIP,
+                   closing_ledger_balance: SKIP, current_ledger_balance: SKIP,
+                   opening_available_balance: SKIP,
+                   current_available_balance: SKIP,
+                   closing_available_balance: SKIP,
+                   next_day_available_balance: SKIP,
+                   two_days_plus_available_balance: SKIP,
+                   number_of_outstanding_credits: SKIP,
+                   outstanding_credits_amount: SKIP,
+                   number_of_outstanding_debits: SKIP,
+                   outstanding_debits_amount: SKIP, transactions: SKIP,
+                   commercial_balances: 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: 'Commercial 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
+      @opening_ledger_balance = opening_ledger_balance unless opening_ledger_balance == SKIP
+      @closing_ledger_balance = closing_ledger_balance unless closing_ledger_balance == SKIP
+      @current_ledger_balance = current_ledger_balance unless current_ledger_balance == SKIP
+      unless opening_available_balance == SKIP
+        @opening_available_balance =
+          opening_available_balance
+      end
+      unless current_available_balance == SKIP
+        @current_available_balance =
+          current_available_balance
+      end
+      unless closing_available_balance == SKIP
+        @closing_available_balance =
+          closing_available_balance
+      end
+      unless next_day_available_balance == SKIP
+        @next_day_available_balance =
+          next_day_available_balance
+      end
+      unless two_days_plus_available_balance == SKIP
+        @two_days_plus_available_balance =
+          two_days_plus_available_balance
+      end
+      unless number_of_outstanding_credits == SKIP
+        @number_of_outstanding_credits =
+          number_of_outstanding_credits
+      end
+      unless outstanding_credits_amount == SKIP
+        @outstanding_credits_amount =
+          outstanding_credits_amount
+      end
+      unless number_of_outstanding_debits == SKIP
+        @number_of_outstanding_debits =
+          number_of_outstanding_debits
+      end
+      unless outstanding_debits_amount == SKIP
+        @outstanding_debits_amount =
+          outstanding_debits_amount
+      end
+      @transactions = transactions unless transactions == SKIP
+      @commercial_balances = commercial_balances unless commercial_balances == 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
+      opening_ledger_balance =
+        hash.key?('openingLedgerBalance') ? hash['openingLedgerBalance'] : SKIP
+      closing_ledger_balance =
+        hash.key?('closingLedgerBalance') ? hash['closingLedgerBalance'] : SKIP
+      current_ledger_balance =
+        hash.key?('currentLedgerBalance') ? hash['currentLedgerBalance'] : SKIP
+      opening_available_balance =
+        hash.key?('openingAvailableBalance') ? hash['openingAvailableBalance'] : SKIP
+      current_available_balance =
+        hash.key?('currentAvailableBalance') ? hash['currentAvailableBalance'] : SKIP
+      closing_available_balance =
+        hash.key?('closingAvailableBalance') ? hash['closingAvailableBalance'] : SKIP
+      next_day_available_balance =
+        hash.key?('nextDayAvailableBalance') ? hash['nextDayAvailableBalance'] : SKIP
+      two_days_plus_available_balance =
+        hash.key?('twoDaysPlusAvailableBalance') ? hash['twoDaysPlusAvailableBalance'] : SKIP
+      number_of_outstanding_credits =
+        hash.key?('numberOfOutstandingCredits') ? hash['numberOfOutstandingCredits'] : SKIP
+      outstanding_credits_amount =
+        hash.key?('outstandingCreditsAmount') ? hash['outstandingCreditsAmount'] : SKIP
+      number_of_outstanding_debits =
+        hash.key?('numberOfOutstandingDebits') ? hash['numberOfOutstandingDebits'] : SKIP
+      outstanding_debits_amount =
+        hash.key?('outstandingDebitsAmount') ? hash['outstandingDebitsAmount'] : 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 << (CommercialTransactionEntity.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+      # Parameter is an array, so we need to iterate through it
+      commercial_balances = nil
+      unless hash['commercialBalances'].nil?
+        commercial_balances = []
+        hash['commercialBalances'].each do |structure|
+          commercial_balances << (CommercialBalanceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      commercial_balances = SKIP unless hash.key?('commercialBalances')
+      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'] ||= 'Commercial 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.
+      CommercialAccountEntity.new(balance_as_of: balance_as_of,
+                                  opening_ledger_balance: opening_ledger_balance,
+                                  closing_ledger_balance: closing_ledger_balance,
+                                  current_ledger_balance: current_ledger_balance,
+                                  opening_available_balance: opening_available_balance,
+                                  current_available_balance: current_available_balance,
+                                  closing_available_balance: closing_available_balance,
+                                  next_day_available_balance: next_day_available_balance,
+                                  two_days_plus_available_balance: two_days_plus_available_balance,
+                                  number_of_outstanding_credits: number_of_outstanding_credits,
+                                  outstanding_credits_amount: outstanding_credits_amount,
+                                  number_of_outstanding_debits: number_of_outstanding_debits,
+                                  outstanding_debits_amount: outstanding_debits_amount,
+                                  transactions: transactions,
+                                  commercial_balances: commercial_balances,
+                                  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 [CommercialAccountEntity | 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}, opening_ledger_balance:"\
+      " #{@opening_ledger_balance}, closing_ledger_balance: #{@closing_ledger_balance},"\
+      " current_ledger_balance: #{@current_ledger_balance}, opening_available_balance:"\
+      " #{@opening_available_balance}, current_available_balance: #{@current_available_balance},"\
+      " closing_available_balance: #{@closing_available_balance}, next_day_available_balance:"\
+      " #{@next_day_available_balance}, two_days_plus_available_balance:"\
+      " #{@two_days_plus_available_balance}, number_of_outstanding_credits:"\
+      " #{@number_of_outstanding_credits}, outstanding_credits_amount:"\
+      " #{@outstanding_credits_amount}, number_of_outstanding_debits:"\
+      " #{@number_of_outstanding_debits}, outstanding_debits_amount:"\
+      " #{@outstanding_debits_amount}, transactions: #{@transactions}, commercial_balances:"\
+      " #{@commercial_balances}>"
+    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},"\
+      " opening_ledger_balance: #{@opening_ledger_balance.inspect}, closing_ledger_balance:"\
+      " #{@closing_ledger_balance.inspect}, current_ledger_balance:"\
+      " #{@current_ledger_balance.inspect}, opening_available_balance:"\
+      " #{@opening_available_balance.inspect}, current_available_balance:"\
+      " #{@current_available_balance.inspect}, closing_available_balance:"\
+      " #{@closing_available_balance.inspect}, next_day_available_balance:"\
+      " #{@next_day_available_balance.inspect}, two_days_plus_available_balance:"\
+      " #{@two_days_plus_available_balance.inspect}, number_of_outstanding_credits:"\
+      " #{@number_of_outstanding_credits.inspect}, outstanding_credits_amount:"\
+      " #{@outstanding_credits_amount.inspect}, number_of_outstanding_debits:"\
+      " #{@number_of_outstanding_debits.inspect}, outstanding_debits_amount:"\
+      " #{@outstanding_debits_amount.inspect}, transactions: #{@transactions.inspect},"\
+      " commercial_balances: #{@commercial_balances.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/commercial_balance_entity.rb

@@ -0,0 +1,106 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A specific treasury management defined balance
+  class CommercialBalanceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The code for a specific treasury management defined field
+    # @return [CommercialCodeEntity1]
+    attr_accessor :commercial_code
+
+    # The treasury management balance amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Memo field for the treasury management balance amount
+    # @return [String]
+    attr_accessor :memo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['commercial_code'] = 'commercialCode'
+      @_hash['amount'] = 'amount'
+      @_hash['memo'] = 'memo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        commercial_code
+        amount
+        memo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(commercial_code: SKIP, amount: SKIP, memo: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @commercial_code = commercial_code unless commercial_code == SKIP
+      @amount = amount unless amount == SKIP
+      @memo = memo unless memo == 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.
+      commercial_code = CommercialCodeEntity1.from_hash(hash['commercialCode']) if
+        hash['commercialCode']
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+
+      # 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.
+      CommercialBalanceEntity.new(commercial_code: commercial_code,
+                                  amount: amount,
+                                  memo: memo,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CommercialBalanceEntity | 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} commercial_code: #{@commercial_code}, amount: #{@amount}, memo: #{@memo},"\
+      " 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} commercial_code: #{@commercial_code.inspect}, amount: #{@amount.inspect},"\
+      " memo: #{@memo.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end