fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/security_detail_irs_form1099_b.rb

@@ -0,0 +1,437 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Tax information for a single security transaction. If reported on Form
+  # 1099-DA, use Tax1099Da and DigitalAssetDetail instead
+  class SecurityDetailIrsForm1099B < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This transaction represents multiple transactions reported on a separate
+    # statement under Exception 2. Code M is shown on Form 8949 column (f)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :multiple
+
+    # This transaction is known to contain incomplete information
+    # @return [TrueClass | FalseClass]
+    attr_accessor :incomplete
+
+    # This transaction is to be reported on Form 1040 Schedule D, either line 1a
+    # for short-term transactions or line 8a for long-term transactions
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exception1
+
+    # ID for a PDF statement delivered in this `TaxStatementList` adjacent to
+    # this tax form, which would contain the full details of the multiple
+    # transactions of this `SecurityDetail` record
+    # @return [String]
+    attr_accessor :tax_statement_id
+
+    # CUSIP number
+    # @return [String]
+    attr_accessor :cusip
+
+    # Applicable checkbox on Form 8949. Use code `A`, `B`, `D`, `E`, or `X`
+    # @return [String]
+    attr_accessor :checkbox_on_form8949
+
+    # Security name
+    # @return [String]
+    attr_accessor :security_name
+
+    # Number of shares
+    # @return [Float]
+    attr_accessor :number_of_shares
+
+    # Box 1a, Description of property
+    # @return [String]
+    attr_accessor :sale_description
+
+    # Box 1b, Date acquired
+    # @return [Date]
+    attr_accessor :date_acquired
+
+    # Box 1b, whether Form 8949 should reflect various acquisition dates
+    # @return [TrueClass | FalseClass]
+    attr_accessor :various_dates_acquired
+
+    # Box 1c, Date sold or disposed
+    # @return [Date]
+    attr_accessor :date_of_sale
+
+    # Box 1d, Proceeds (not price per share)
+    # @return [Float]
+    attr_accessor :sales_price
+
+    # Box 1f, Accrued market discount
+    # @return [Float]
+    attr_accessor :accrued_market_discount
+
+    # Other adjustments (code and amount)
+    # @return [Array[CodeAndAmount]]
+    attr_accessor :adjustment_codes
+
+    # Box 1e, Cost or other basis
+    # @return [Float]
+    attr_accessor :cost_basis
+
+    # Corrected cost basis. May be supplied in lieu of adjustmentCode code B. If
+    # both adjustmentCodes and correctedCostBasis are supplied, costBasis plus
+    # adjustmentCode B should equal correctedCostBasis
+    # @return [Float]
+    attr_accessor :corrected_cost_basis
+
+    # Box 1g, Wash sale loss disallowed
+    # @return [Float]
+    attr_accessor :wash_sale_loss_disallowed
+
+    # Box 2, LONG or SHORT
+    # @return [SaleTermType2]
+    attr_accessor :long_or_short
+
+    # Box 2, Ordinary
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ordinary
+
+    # Box 3, Collectibles
+    # @return [TrueClass | FalseClass]
+    attr_accessor :collectible
+
+    # Box 3, Qualified Opportunity Fund (QOF)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :qof
+
+    # Box 4, Federal income tax withheld
+    # @return [Float]
+    attr_accessor :federal_tax_withheld
+
+    # Box 5, Noncovered security
+    # @return [TrueClass | FalseClass]
+    attr_accessor :noncovered_security
+
+    # Box 6, Reported to IRS: GROSS or NET
+    # @return [SaleProceedsType1]
+    attr_accessor :gross_or_net
+
+    # Box 7, Loss not allowed based on proceeds
+    # @return [TrueClass | FalseClass]
+    attr_accessor :loss_not_allowed
+
+    # Box 12, Basis reported to IRS
+    # @return [TrueClass | FalseClass]
+    attr_accessor :basis_reported
+
+    # Boxes 14-16, State and Local tax withholding
+    # @return [Array[StateAndLocalTaxWithholding]]
+    attr_accessor :state_and_local
+
+    # Foreign account tax compliance
+    # @return [TrueClass | FalseClass]
+    attr_accessor :foreign_account_tax_compliance
+
+    # To indicate gain or loss resulted from option expiration. If salesPrice
+    # (1d, proceeds) is zero, use PURCHASED. If costBasis (1e) is zero, use
+    # GRANTED
+    # @return [ExpiredOptionType2]
+    attr_accessor :expired_option
+
+    # Type of investment sale
+    # @return [InvestmentSaleType]
+    attr_accessor :investment_sale_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['multiple'] = 'multiple'
+      @_hash['incomplete'] = 'incomplete'
+      @_hash['exception1'] = 'exception1'
+      @_hash['tax_statement_id'] = 'taxStatementId'
+      @_hash['cusip'] = 'cusip'
+      @_hash['checkbox_on_form8949'] = 'checkboxOnForm8949'
+      @_hash['security_name'] = 'securityName'
+      @_hash['number_of_shares'] = 'numberOfShares'
+      @_hash['sale_description'] = 'saleDescription'
+      @_hash['date_acquired'] = 'dateAcquired'
+      @_hash['various_dates_acquired'] = 'variousDatesAcquired'
+      @_hash['date_of_sale'] = 'dateOfSale'
+      @_hash['sales_price'] = 'salesPrice'
+      @_hash['accrued_market_discount'] = 'accruedMarketDiscount'
+      @_hash['adjustment_codes'] = 'adjustmentCodes'
+      @_hash['cost_basis'] = 'costBasis'
+      @_hash['corrected_cost_basis'] = 'correctedCostBasis'
+      @_hash['wash_sale_loss_disallowed'] = 'washSaleLossDisallowed'
+      @_hash['long_or_short'] = 'longOrShort'
+      @_hash['ordinary'] = 'ordinary'
+      @_hash['collectible'] = 'collectible'
+      @_hash['qof'] = 'qof'
+      @_hash['federal_tax_withheld'] = 'federalTaxWithheld'
+      @_hash['noncovered_security'] = 'noncoveredSecurity'
+      @_hash['gross_or_net'] = 'grossOrNet'
+      @_hash['loss_not_allowed'] = 'lossNotAllowed'
+      @_hash['basis_reported'] = 'basisReported'
+      @_hash['state_and_local'] = 'stateAndLocal'
+      @_hash['foreign_account_tax_compliance'] = 'foreignAccountTaxCompliance'
+      @_hash['expired_option'] = 'expiredOption'
+      @_hash['investment_sale_type'] = 'investmentSaleType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        multiple
+        incomplete
+        exception1
+        tax_statement_id
+        cusip
+        checkbox_on_form8949
+        security_name
+        number_of_shares
+        sale_description
+        date_acquired
+        various_dates_acquired
+        date_of_sale
+        sales_price
+        accrued_market_discount
+        adjustment_codes
+        cost_basis
+        corrected_cost_basis
+        wash_sale_loss_disallowed
+        long_or_short
+        ordinary
+        collectible
+        qof
+        federal_tax_withheld
+        noncovered_security
+        gross_or_net
+        loss_not_allowed
+        basis_reported
+        state_and_local
+        foreign_account_tax_compliance
+        expired_option
+        investment_sale_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(multiple: SKIP, incomplete: SKIP, exception1: SKIP,
+                   tax_statement_id: SKIP, cusip: SKIP,
+                   checkbox_on_form8949: SKIP, security_name: SKIP,
+                   number_of_shares: SKIP, sale_description: SKIP,
+                   date_acquired: SKIP, various_dates_acquired: SKIP,
+                   date_of_sale: SKIP, sales_price: SKIP,
+                   accrued_market_discount: SKIP, adjustment_codes: SKIP,
+                   cost_basis: SKIP, corrected_cost_basis: SKIP,
+                   wash_sale_loss_disallowed: SKIP, long_or_short: SKIP,
+                   ordinary: SKIP, collectible: SKIP, qof: SKIP,
+                   federal_tax_withheld: SKIP, noncovered_security: SKIP,
+                   gross_or_net: SKIP, loss_not_allowed: SKIP,
+                   basis_reported: SKIP, state_and_local: SKIP,
+                   foreign_account_tax_compliance: SKIP, expired_option: SKIP,
+                   investment_sale_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @multiple = multiple unless multiple == SKIP
+      @incomplete = incomplete unless incomplete == SKIP
+      @exception1 = exception1 unless exception1 == SKIP
+      @tax_statement_id = tax_statement_id unless tax_statement_id == SKIP
+      @cusip = cusip unless cusip == SKIP
+      @checkbox_on_form8949 = checkbox_on_form8949 unless checkbox_on_form8949 == SKIP
+      @security_name = security_name unless security_name == SKIP
+      @number_of_shares = number_of_shares unless number_of_shares == SKIP
+      @sale_description = sale_description unless sale_description == SKIP
+      @date_acquired = date_acquired unless date_acquired == SKIP
+      @various_dates_acquired = various_dates_acquired unless various_dates_acquired == SKIP
+      @date_of_sale = date_of_sale unless date_of_sale == SKIP
+      @sales_price = sales_price unless sales_price == SKIP
+      @accrued_market_discount = accrued_market_discount unless accrued_market_discount == SKIP
+      @adjustment_codes = adjustment_codes unless adjustment_codes == SKIP
+      @cost_basis = cost_basis unless cost_basis == SKIP
+      @corrected_cost_basis = corrected_cost_basis unless corrected_cost_basis == SKIP
+      unless wash_sale_loss_disallowed == SKIP
+        @wash_sale_loss_disallowed =
+          wash_sale_loss_disallowed
+      end
+      @long_or_short = long_or_short unless long_or_short == SKIP
+      @ordinary = ordinary unless ordinary == SKIP
+      @collectible = collectible unless collectible == SKIP
+      @qof = qof unless qof == SKIP
+      @federal_tax_withheld = federal_tax_withheld unless federal_tax_withheld == SKIP
+      @noncovered_security = noncovered_security unless noncovered_security == SKIP
+      @gross_or_net = gross_or_net unless gross_or_net == SKIP
+      @loss_not_allowed = loss_not_allowed unless loss_not_allowed == SKIP
+      @basis_reported = basis_reported unless basis_reported == SKIP
+      @state_and_local = state_and_local unless state_and_local == SKIP
+      unless foreign_account_tax_compliance == SKIP
+        @foreign_account_tax_compliance =
+          foreign_account_tax_compliance
+      end
+      @expired_option = expired_option unless expired_option == SKIP
+      @investment_sale_type = investment_sale_type unless investment_sale_type == 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.
+      multiple = hash.key?('multiple') ? hash['multiple'] : SKIP
+      incomplete = hash.key?('incomplete') ? hash['incomplete'] : SKIP
+      exception1 = hash.key?('exception1') ? hash['exception1'] : SKIP
+      tax_statement_id =
+        hash.key?('taxStatementId') ? hash['taxStatementId'] : SKIP
+      cusip = hash.key?('cusip') ? hash['cusip'] : SKIP
+      checkbox_on_form8949 =
+        hash.key?('checkboxOnForm8949') ? hash['checkboxOnForm8949'] : SKIP
+      security_name = hash.key?('securityName') ? hash['securityName'] : SKIP
+      number_of_shares =
+        hash.key?('numberOfShares') ? hash['numberOfShares'] : SKIP
+      sale_description =
+        hash.key?('saleDescription') ? hash['saleDescription'] : SKIP
+      date_acquired = hash.key?('dateAcquired') ? hash['dateAcquired'] : SKIP
+      various_dates_acquired =
+        hash.key?('variousDatesAcquired') ? hash['variousDatesAcquired'] : SKIP
+      date_of_sale = hash.key?('dateOfSale') ? hash['dateOfSale'] : SKIP
+      sales_price = hash.key?('salesPrice') ? hash['salesPrice'] : SKIP
+      accrued_market_discount =
+        hash.key?('accruedMarketDiscount') ? hash['accruedMarketDiscount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      adjustment_codes = nil
+      unless hash['adjustmentCodes'].nil?
+        adjustment_codes = []
+        hash['adjustmentCodes'].each do |structure|
+          adjustment_codes << (CodeAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      adjustment_codes = SKIP unless hash.key?('adjustmentCodes')
+      cost_basis = hash.key?('costBasis') ? hash['costBasis'] : SKIP
+      corrected_cost_basis =
+        hash.key?('correctedCostBasis') ? hash['correctedCostBasis'] : SKIP
+      wash_sale_loss_disallowed =
+        hash.key?('washSaleLossDisallowed') ? hash['washSaleLossDisallowed'] : SKIP
+      long_or_short = hash.key?('longOrShort') ? hash['longOrShort'] : SKIP
+      ordinary = hash.key?('ordinary') ? hash['ordinary'] : SKIP
+      collectible = hash.key?('collectible') ? hash['collectible'] : SKIP
+      qof = hash.key?('qof') ? hash['qof'] : SKIP
+      federal_tax_withheld =
+        hash.key?('federalTaxWithheld') ? hash['federalTaxWithheld'] : SKIP
+      noncovered_security =
+        hash.key?('noncoveredSecurity') ? hash['noncoveredSecurity'] : SKIP
+      gross_or_net = hash.key?('grossOrNet') ? hash['grossOrNet'] : SKIP
+      loss_not_allowed =
+        hash.key?('lossNotAllowed') ? hash['lossNotAllowed'] : SKIP
+      basis_reported = hash.key?('basisReported') ? hash['basisReported'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      state_and_local = nil
+      unless hash['stateAndLocal'].nil?
+        state_and_local = []
+        hash['stateAndLocal'].each do |structure|
+          state_and_local << (StateAndLocalTaxWithholding.from_hash(structure) if structure)
+        end
+      end
+
+      state_and_local = SKIP unless hash.key?('stateAndLocal')
+      foreign_account_tax_compliance =
+        hash.key?('foreignAccountTaxCompliance') ? hash['foreignAccountTaxCompliance'] : SKIP
+      expired_option = hash.key?('expiredOption') ? hash['expiredOption'] : SKIP
+      investment_sale_type =
+        hash.key?('investmentSaleType') ? hash['investmentSaleType'] : 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.
+      SecurityDetailIrsForm1099B.new(multiple: multiple,
+                                     incomplete: incomplete,
+                                     exception1: exception1,
+                                     tax_statement_id: tax_statement_id,
+                                     cusip: cusip,
+                                     checkbox_on_form8949: checkbox_on_form8949,
+                                     security_name: security_name,
+                                     number_of_shares: number_of_shares,
+                                     sale_description: sale_description,
+                                     date_acquired: date_acquired,
+                                     various_dates_acquired: various_dates_acquired,
+                                     date_of_sale: date_of_sale,
+                                     sales_price: sales_price,
+                                     accrued_market_discount: accrued_market_discount,
+                                     adjustment_codes: adjustment_codes,
+                                     cost_basis: cost_basis,
+                                     corrected_cost_basis: corrected_cost_basis,
+                                     wash_sale_loss_disallowed: wash_sale_loss_disallowed,
+                                     long_or_short: long_or_short,
+                                     ordinary: ordinary,
+                                     collectible: collectible,
+                                     qof: qof,
+                                     federal_tax_withheld: federal_tax_withheld,
+                                     noncovered_security: noncovered_security,
+                                     gross_or_net: gross_or_net,
+                                     loss_not_allowed: loss_not_allowed,
+                                     basis_reported: basis_reported,
+                                     state_and_local: state_and_local,
+                                     foreign_account_tax_compliance: foreign_account_tax_compliance,
+                                     expired_option: expired_option,
+                                     investment_sale_type: investment_sale_type,
+                                     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} multiple: #{@multiple}, incomplete: #{@incomplete}, exception1:"\
+      " #{@exception1}, tax_statement_id: #{@tax_statement_id}, cusip: #{@cusip},"\
+      " checkbox_on_form8949: #{@checkbox_on_form8949}, security_name: #{@security_name},"\
+      " number_of_shares: #{@number_of_shares}, sale_description: #{@sale_description},"\
+      " date_acquired: #{@date_acquired}, various_dates_acquired: #{@various_dates_acquired},"\
+      " date_of_sale: #{@date_of_sale}, sales_price: #{@sales_price}, accrued_market_discount:"\
+      " #{@accrued_market_discount}, adjustment_codes: #{@adjustment_codes}, cost_basis:"\
+      " #{@cost_basis}, corrected_cost_basis: #{@corrected_cost_basis}, wash_sale_loss_disallowed:"\
+      " #{@wash_sale_loss_disallowed}, long_or_short: #{@long_or_short}, ordinary: #{@ordinary},"\
+      " collectible: #{@collectible}, qof: #{@qof}, federal_tax_withheld:"\
+      " #{@federal_tax_withheld}, noncovered_security: #{@noncovered_security}, gross_or_net:"\
+      " #{@gross_or_net}, loss_not_allowed: #{@loss_not_allowed}, basis_reported:"\
+      " #{@basis_reported}, state_and_local: #{@state_and_local}, foreign_account_tax_compliance:"\
+      " #{@foreign_account_tax_compliance}, expired_option: #{@expired_option},"\
+      " investment_sale_type: #{@investment_sale_type}, 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} multiple: #{@multiple.inspect}, incomplete: #{@incomplete.inspect},"\
+      " exception1: #{@exception1.inspect}, tax_statement_id: #{@tax_statement_id.inspect}, cusip:"\
+      " #{@cusip.inspect}, checkbox_on_form8949: #{@checkbox_on_form8949.inspect}, security_name:"\
+      " #{@security_name.inspect}, number_of_shares: #{@number_of_shares.inspect},"\
+      " sale_description: #{@sale_description.inspect}, date_acquired: #{@date_acquired.inspect},"\
+      " various_dates_acquired: #{@various_dates_acquired.inspect}, date_of_sale:"\
+      " #{@date_of_sale.inspect}, sales_price: #{@sales_price.inspect}, accrued_market_discount:"\
+      " #{@accrued_market_discount.inspect}, adjustment_codes: #{@adjustment_codes.inspect},"\
+      " cost_basis: #{@cost_basis.inspect}, corrected_cost_basis:"\
+      " #{@corrected_cost_basis.inspect}, wash_sale_loss_disallowed:"\
+      " #{@wash_sale_loss_disallowed.inspect}, long_or_short: #{@long_or_short.inspect}, ordinary:"\
+      " #{@ordinary.inspect}, collectible: #{@collectible.inspect}, qof: #{@qof.inspect},"\
+      " federal_tax_withheld: #{@federal_tax_withheld.inspect}, noncovered_security:"\
+      " #{@noncovered_security.inspect}, gross_or_net: #{@gross_or_net.inspect}, loss_not_allowed:"\
+      " #{@loss_not_allowed.inspect}, basis_reported: #{@basis_reported.inspect}, state_and_local:"\
+      " #{@state_and_local.inspect}, foreign_account_tax_compliance:"\
+      " #{@foreign_account_tax_compliance.inspect}, expired_option: #{@expired_option.inspect},"\
+      " investment_sale_type: #{@investment_sale_type.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_entity.rb

@@ -0,0 +1,118 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A base Security entity which defines the type of this security
+  class SecurityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :security_category
+
+    # Array of FI-specific attributes
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['Annuity Security entity'] = AnnuitySecurityEntity
+        @_discriminators['Certificate Of Deposit Security entity'] = CertificateOfDepositSecurityEntity
+        @_discriminators['Debt Security entity'] = DebtSecurityEntity
+        @_discriminators['Digital Asset Security entity'] = DigitalAssetSecurityEntity
+        @_discriminators['Mutual Fund Security entity'] = MutualFundSecurityEntity
+        @_discriminators['Option Security entity'] = OptionSecurityEntity
+        @_discriminators['Other Security entity'] = OtherSecurityEntity
+        @_discriminators['Stock Security entity'] = StockSecurityEntity
+        @_discriminators['Sweep Security entity'] = SweepSecurityEntity
+        @_discriminators['Bond Security entity'] = BondSecurityEntity
+      end
+      @_discriminators
+    end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['security_category'] = 'securityCategory'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        security_category
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(security_category: 'Security entity', fi_attributes: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @security_category = security_category unless security_category == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Delegate unboxing to another function if a discriminator
+      # value for a child class is present.
+      unboxer = discriminators[hash['securityCategory']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # Extract variables from the hash.
+      security_category = hash['securityCategory'] ||= 'Security entity'
+      # 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.
+      SecurityEntity.new(security_category: security_category,
+                         fi_attributes: fi_attributes,
+                         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} security_category: #{@security_category}, fi_attributes: #{@fi_attributes},"\
+      " 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} security_category: #{@security_category.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_id_entity.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Unique identifier for a security
+  class SecurityIdEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Security identifier
+    # @return [String]
+    attr_accessor :id
+
+    # CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN
+    # @return [SecurityIdType1]
+    attr_accessor :id_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['id_type'] = 'idType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        id_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, id_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @id_type = id_type unless id_type == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      id_type = hash.key?('idType') ? hash['idType'] : 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.
+      SecurityIdEntity.new(id: id,
+                           id_type: id_type,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SecurityIdEntity | 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} id: #{@id}, id_type: #{@id_type}, 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} id: #{@id.inspect}, id_type: #{@id_type.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end