apimatic-ak-sdk 0.0.1

data/lib/akoya/models/an_investment_holding.rb

@@ -0,0 +1,493 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # AnInvestmentHolding Model.
+  class AnInvestmentHolding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Percent breakdown by asset class.
+    # @return [Array[AssetClassAnInvestmentHolding]]
+    attr_accessor :asset_classes
+
+    # Cost is average of all purchases for holding.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :average_cost
+
+    # If true, indicates that this holding is used to maintain proceeds from
+    # sales, dividends, and other cash postings to the investment account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cash_account
+
+    # Change in current price compared to previous day's close
+    # @return [Float]
+    attr_accessor :change_in_price
+
+    # Indicates the currency code used by the account. May also include currency
+    # rate.
+    # @return [CurrencyEntity]
+    attr_accessor :currency
+
+    # Indicates the currency code used by the account. May also include currency
+    # rate.
+    # @return [Float]
+    attr_accessor :current_unit_price
+
+    # Current unit price as of date
+    # @return [DateTime]
+    attr_accessor :current_unit_price_date
+
+    # Description of the holding
+    # @return [String]
+    attr_accessor :description
+
+    # For CDs, bonds, and other time-based holdings.
+    # @return [DateTime]
+    attr_accessor :expiration_date
+
+    # Required for bonds. Face value at the time of data retrieved.
+    # @return [Float]
+    attr_accessor :face_value
+
+    # Percent breakdown by FI-specific asset class percentage breakdown
+    # @return [Array[FiAssetClassAnInvestmentHolding]]
+    attr_accessor :fi_asset_classes
+
+    # Percent breakdown by FI-specific asset class percentage breakdown
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # Sub-account
+    # @return [HeldInAccount]
+    attr_accessor :held_in_account
+
+    # Long term persistent identity of the holding
+    # @return [String]
+    attr_accessor :holding_id
+
+    # Holding name or security name
+    # @return [String]
+    attr_accessor :holding_name
+
+    # Holding name or security name
+    # @return [HoldingSubType]
+    attr_accessor :holding_sub_type
+
+    # Holding name or security name
+    # @return [HoldingType]
+    attr_accessor :holding_type
+
+    # Source for money for this security.
+    # @return [Inv401KSurce]
+    attr_accessor :inv401k_surce
+
+    # Market value at the time of data retrieved
+    # @return [Float]
+    attr_accessor :market_value
+
+    # Date of original purchase
+    # @return [DateTime]
+    attr_accessor :original_purchase_date
+
+    # Date of original purchase
+    # @return [PositionType]
+    attr_accessor :position_type
+
+    # Price of holding at the time of purchase
+    # @return [Float]
+    attr_accessor :purchased_price
+
+    # For CDs, bonds, and other rate based holdings.
+    # @return [Float]
+    attr_accessor :rate
+
+    # Unique identifier of security
+    # @return [String]
+    attr_accessor :security_id
+
+    # Security identifier type
+    # @return [SecurityIdType]
+    attr_accessor :security_id_type
+
+    # Ticker / Market symbol
+    # @return [String]
+    attr_accessor :symbol
+
+    # Breakdown by tax lot.
+    # @return [Array[TaxLotAnInvestmentHolding]]
+    attr_accessor :tax_lots
+
+    # Required for stock, mutual funds. Number of shares (with decimals).
+    # @return [Float]
+    attr_accessor :units
+
+    # Information about the mutual fund security specific to the type of
+    # security
+    # @return [MutualFundSecurityEntity]
+    attr_accessor :mutual_fund_security
+
+    # Information about the option security specific to the type of security
+    # @return [OptionSecurityEntity]
+    attr_accessor :option_security
+
+    # Information about the security specific to the type of security
+    # @return [OtherSecurityEntity]
+    attr_accessor :other_security
+
+    # Information about the stock security specific to the type of security
+    # @return [StockSecurityEntity]
+    attr_accessor :stock_security
+
+    # Information about the sweep security specific to the type of security
+    # @return [SweepSecurityEntity]
+    attr_accessor :sweep_security
+
+    # Information about the debt security specific to the type of security
+    # @return [DebtSecurityEntity]
+    attr_accessor :debt_security
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_classes'] = 'assetClasses'
+      @_hash['average_cost'] = 'averageCost'
+      @_hash['cash_account'] = 'cashAccount'
+      @_hash['change_in_price'] = 'changeInPrice'
+      @_hash['currency'] = 'currency'
+      @_hash['current_unit_price'] = 'currentUnitPrice'
+      @_hash['current_unit_price_date'] = 'currentUnitPriceDate'
+      @_hash['description'] = 'description'
+      @_hash['expiration_date'] = 'expirationDate'
+      @_hash['face_value'] = 'faceValue'
+      @_hash['fi_asset_classes'] = 'fiAssetClasses'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash['held_in_account'] = 'heldInAccount'
+      @_hash['holding_id'] = 'holdingId'
+      @_hash['holding_name'] = 'holdingName'
+      @_hash['holding_sub_type'] = 'holdingSubType'
+      @_hash['holding_type'] = 'holdingType'
+      @_hash['inv401k_surce'] = 'inv401kSurce'
+      @_hash['market_value'] = 'marketValue'
+      @_hash['original_purchase_date'] = 'originalPurchaseDate'
+      @_hash['position_type'] = 'positionType'
+      @_hash['purchased_price'] = 'purchasedPrice'
+      @_hash['rate'] = 'rate'
+      @_hash['security_id'] = 'securityId'
+      @_hash['security_id_type'] = 'securityIdType'
+      @_hash['symbol'] = 'symbol'
+      @_hash['tax_lots'] = 'taxLots'
+      @_hash['units'] = 'units'
+      @_hash['mutual_fund_security'] = 'mutualFundSecurity'
+      @_hash['option_security'] = 'optionSecurity'
+      @_hash['other_security'] = 'otherSecurity'
+      @_hash['stock_security'] = 'stockSecurity'
+      @_hash['sweep_security'] = 'sweepSecurity'
+      @_hash['debt_security'] = 'debtSecurity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_classes
+        average_cost
+        cash_account
+        change_in_price
+        currency
+        current_unit_price
+        current_unit_price_date
+        description
+        expiration_date
+        face_value
+        fi_asset_classes
+        fi_attributes
+        held_in_account
+        holding_id
+        holding_name
+        holding_sub_type
+        holding_type
+        inv401k_surce
+        market_value
+        original_purchase_date
+        position_type
+        purchased_price
+        rate
+        security_id
+        security_id_type
+        symbol
+        tax_lots
+        units
+        mutual_fund_security
+        option_security
+        other_security
+        stock_security
+        sweep_security
+        debt_security
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_classes: SKIP, average_cost: SKIP, cash_account: SKIP,
+                   change_in_price: SKIP, currency: SKIP,
+                   current_unit_price: SKIP, current_unit_price_date: SKIP,
+                   description: SKIP, expiration_date: SKIP, face_value: SKIP,
+                   fi_asset_classes: SKIP, fi_attributes: SKIP,
+                   held_in_account: SKIP, holding_id: SKIP, holding_name: SKIP,
+                   holding_sub_type: SKIP, holding_type: SKIP,
+                   inv401k_surce: SKIP, market_value: SKIP,
+                   original_purchase_date: SKIP, position_type: SKIP,
+                   purchased_price: SKIP, rate: SKIP, security_id: SKIP,
+                   security_id_type: SKIP, symbol: SKIP, tax_lots: SKIP,
+                   units: SKIP, mutual_fund_security: SKIP,
+                   option_security: SKIP, other_security: SKIP,
+                   stock_security: SKIP, sweep_security: SKIP,
+                   debt_security: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_classes = asset_classes unless asset_classes == SKIP
+      @average_cost = average_cost unless average_cost == SKIP
+      @cash_account = cash_account unless cash_account == SKIP
+      @change_in_price = change_in_price unless change_in_price == SKIP
+      @currency = currency unless currency == SKIP
+      @current_unit_price = current_unit_price unless current_unit_price == SKIP
+      @current_unit_price_date = current_unit_price_date unless current_unit_price_date == SKIP
+      @description = description unless description == SKIP
+      @expiration_date = expiration_date unless expiration_date == SKIP
+      @face_value = face_value unless face_value == SKIP
+      @fi_asset_classes = fi_asset_classes unless fi_asset_classes == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == SKIP
+      @held_in_account = held_in_account unless held_in_account == SKIP
+      @holding_id = holding_id unless holding_id == SKIP
+      @holding_name = holding_name unless holding_name == SKIP
+      @holding_sub_type = holding_sub_type unless holding_sub_type == SKIP
+      @holding_type = holding_type unless holding_type == SKIP
+      @inv401k_surce = inv401k_surce unless inv401k_surce == SKIP
+      @market_value = market_value unless market_value == SKIP
+      @original_purchase_date = original_purchase_date unless original_purchase_date == SKIP
+      @position_type = position_type unless position_type == SKIP
+      @purchased_price = purchased_price unless purchased_price == SKIP
+      @rate = rate unless rate == SKIP
+      @security_id = security_id unless security_id == SKIP
+      @security_id_type = security_id_type unless security_id_type == SKIP
+      @symbol = symbol unless symbol == SKIP
+      @tax_lots = tax_lots unless tax_lots == SKIP
+      @units = units unless units == SKIP
+      @mutual_fund_security = mutual_fund_security unless mutual_fund_security == SKIP
+      @option_security = option_security unless option_security == SKIP
+      @other_security = other_security unless other_security == SKIP
+      @stock_security = stock_security unless stock_security == SKIP
+      @sweep_security = sweep_security unless sweep_security == SKIP
+      @debt_security = debt_security unless debt_security == 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.
+      # Parameter is an array, so we need to iterate through it
+      asset_classes = nil
+      unless hash['assetClasses'].nil?
+        asset_classes = []
+        hash['assetClasses'].each do |structure|
+          asset_classes << (AssetClassAnInvestmentHolding.from_hash(structure) if structure)
+        end
+      end
+
+      asset_classes = SKIP unless hash.key?('assetClasses')
+      average_cost = hash.key?('averageCost') ? hash['averageCost'] : SKIP
+      cash_account = hash.key?('cashAccount') ? hash['cashAccount'] : SKIP
+      change_in_price =
+        hash.key?('changeInPrice') ? hash['changeInPrice'] : SKIP
+      currency = CurrencyEntity.from_hash(hash['currency']) if hash['currency']
+      current_unit_price =
+        hash.key?('currentUnitPrice') ? hash['currentUnitPrice'] : SKIP
+      current_unit_price_date = if hash.key?('currentUnitPriceDate')
+                                  (DateTimeHelper.from_rfc3339(hash['currentUnitPriceDate']) if hash['currentUnitPriceDate'])
+                                else
+                                  SKIP
+                                end
+      description = hash.key?('description') ? hash['description'] : SKIP
+      expiration_date = if hash.key?('expirationDate')
+                          (DateTimeHelper.from_rfc3339(hash['expirationDate']) if hash['expirationDate'])
+                        else
+                          SKIP
+                        end
+      face_value = hash.key?('faceValue') ? hash['faceValue'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      fi_asset_classes = nil
+      unless hash['fiAssetClasses'].nil?
+        fi_asset_classes = []
+        hash['fiAssetClasses'].each do |structure|
+          fi_asset_classes << (FiAssetClassAnInvestmentHolding.from_hash(structure) if structure)
+        end
+      end
+
+      fi_asset_classes = SKIP unless hash.key?('fiAssetClasses')
+      # 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')
+      held_in_account =
+        hash.key?('heldInAccount') ? hash['heldInAccount'] : SKIP
+      holding_id = hash.key?('holdingId') ? hash['holdingId'] : SKIP
+      holding_name = hash.key?('holdingName') ? hash['holdingName'] : SKIP
+      holding_sub_type =
+        hash.key?('holdingSubType') ? hash['holdingSubType'] : SKIP
+      holding_type = hash.key?('holdingType') ? hash['holdingType'] : SKIP
+      inv401k_surce = hash.key?('inv401kSurce') ? hash['inv401kSurce'] : SKIP
+      market_value = hash.key?('marketValue') ? hash['marketValue'] : SKIP
+      original_purchase_date = if hash.key?('originalPurchaseDate')
+                                 (DateTimeHelper.from_rfc3339(hash['originalPurchaseDate']) if hash['originalPurchaseDate'])
+                               else
+                                 SKIP
+                               end
+      position_type = hash.key?('positionType') ? hash['positionType'] : SKIP
+      purchased_price =
+        hash.key?('purchasedPrice') ? hash['purchasedPrice'] : SKIP
+      rate = hash.key?('rate') ? hash['rate'] : SKIP
+      security_id = hash.key?('securityId') ? hash['securityId'] : SKIP
+      security_id_type =
+        hash.key?('securityIdType') ? hash['securityIdType'] : SKIP
+      symbol = hash.key?('symbol') ? hash['symbol'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tax_lots = nil
+      unless hash['taxLots'].nil?
+        tax_lots = []
+        hash['taxLots'].each do |structure|
+          tax_lots << (TaxLotAnInvestmentHolding.from_hash(structure) if structure)
+        end
+      end
+
+      tax_lots = SKIP unless hash.key?('taxLots')
+      units = hash.key?('units') ? hash['units'] : SKIP
+      mutual_fund_security = MutualFundSecurityEntity.from_hash(hash['mutualFundSecurity']) if
+        hash['mutualFundSecurity']
+      option_security = OptionSecurityEntity.from_hash(hash['optionSecurity']) if
+        hash['optionSecurity']
+      other_security = OtherSecurityEntity.from_hash(hash['otherSecurity']) if
+        hash['otherSecurity']
+      stock_security = StockSecurityEntity.from_hash(hash['stockSecurity']) if
+        hash['stockSecurity']
+      sweep_security = SweepSecurityEntity.from_hash(hash['sweepSecurity']) if
+        hash['sweepSecurity']
+      debt_security = DebtSecurityEntity.from_hash(hash['debtSecurity']) if hash['debtSecurity']
+
+      # 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.
+      AnInvestmentHolding.new(asset_classes: asset_classes,
+                              average_cost: average_cost,
+                              cash_account: cash_account,
+                              change_in_price: change_in_price,
+                              currency: currency,
+                              current_unit_price: current_unit_price,
+                              current_unit_price_date: current_unit_price_date,
+                              description: description,
+                              expiration_date: expiration_date,
+                              face_value: face_value,
+                              fi_asset_classes: fi_asset_classes,
+                              fi_attributes: fi_attributes,
+                              held_in_account: held_in_account,
+                              holding_id: holding_id,
+                              holding_name: holding_name,
+                              holding_sub_type: holding_sub_type,
+                              holding_type: holding_type,
+                              inv401k_surce: inv401k_surce,
+                              market_value: market_value,
+                              original_purchase_date: original_purchase_date,
+                              position_type: position_type,
+                              purchased_price: purchased_price,
+                              rate: rate,
+                              security_id: security_id,
+                              security_id_type: security_id_type,
+                              symbol: symbol,
+                              tax_lots: tax_lots,
+                              units: units,
+                              mutual_fund_security: mutual_fund_security,
+                              option_security: option_security,
+                              other_security: other_security,
+                              stock_security: stock_security,
+                              sweep_security: sweep_security,
+                              debt_security: debt_security,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_current_unit_price_date
+      DateTimeHelper.to_rfc3339(current_unit_price_date)
+    end
+
+    def to_custom_expiration_date
+      DateTimeHelper.to_rfc3339(expiration_date)
+    end
+
+    def to_custom_original_purchase_date
+      DateTimeHelper.to_rfc3339(original_purchase_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} asset_classes: #{@asset_classes}, average_cost: #{@average_cost},"\
+      " cash_account: #{@cash_account}, change_in_price: #{@change_in_price}, currency:"\
+      " #{@currency}, current_unit_price: #{@current_unit_price}, current_unit_price_date:"\
+      " #{@current_unit_price_date}, description: #{@description}, expiration_date:"\
+      " #{@expiration_date}, face_value: #{@face_value}, fi_asset_classes: #{@fi_asset_classes},"\
+      " fi_attributes: #{@fi_attributes}, held_in_account: #{@held_in_account}, holding_id:"\
+      " #{@holding_id}, holding_name: #{@holding_name}, holding_sub_type: #{@holding_sub_type},"\
+      " holding_type: #{@holding_type}, inv401k_surce: #{@inv401k_surce}, market_value:"\
+      " #{@market_value}, original_purchase_date: #{@original_purchase_date}, position_type:"\
+      " #{@position_type}, purchased_price: #{@purchased_price}, rate: #{@rate}, security_id:"\
+      " #{@security_id}, security_id_type: #{@security_id_type}, symbol: #{@symbol}, tax_lots:"\
+      " #{@tax_lots}, units: #{@units}, mutual_fund_security: #{@mutual_fund_security},"\
+      " option_security: #{@option_security}, other_security: #{@other_security}, stock_security:"\
+      " #{@stock_security}, sweep_security: #{@sweep_security}, debt_security: #{@debt_security},"\
+      " 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} asset_classes: #{@asset_classes.inspect}, average_cost:"\
+      " #{@average_cost.inspect}, cash_account: #{@cash_account.inspect}, change_in_price:"\
+      " #{@change_in_price.inspect}, currency: #{@currency.inspect}, current_unit_price:"\
+      " #{@current_unit_price.inspect}, current_unit_price_date:"\
+      " #{@current_unit_price_date.inspect}, description: #{@description.inspect},"\
+      " expiration_date: #{@expiration_date.inspect}, face_value: #{@face_value.inspect},"\
+      " fi_asset_classes: #{@fi_asset_classes.inspect}, fi_attributes: #{@fi_attributes.inspect},"\
+      " held_in_account: #{@held_in_account.inspect}, holding_id: #{@holding_id.inspect},"\
+      " holding_name: #{@holding_name.inspect}, holding_sub_type: #{@holding_sub_type.inspect},"\
+      " holding_type: #{@holding_type.inspect}, inv401k_surce: #{@inv401k_surce.inspect},"\
+      " market_value: #{@market_value.inspect}, original_purchase_date:"\
+      " #{@original_purchase_date.inspect}, position_type: #{@position_type.inspect},"\
+      " purchased_price: #{@purchased_price.inspect}, rate: #{@rate.inspect}, security_id:"\
+      " #{@security_id.inspect}, security_id_type: #{@security_id_type.inspect}, symbol:"\
+      " #{@symbol.inspect}, tax_lots: #{@tax_lots.inspect}, units: #{@units.inspect},"\
+      " mutual_fund_security: #{@mutual_fund_security.inspect}, option_security:"\
+      " #{@option_security.inspect}, other_security: #{@other_security.inspect}, stock_security:"\
+      " #{@stock_security.inspect}, sweep_security: #{@sweep_security.inspect}, debt_security:"\
+      " #{@debt_security.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/annual_increase_type.rb

@@ -0,0 +1,40 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # AnnualIncreaseType.
+  class AnnualIncreaseType
+    ANNUAL_INCREASE_TYPE = [
+      # TODO: Write general description for FIXED
+      FIXED = 'FIXED'.freeze,
+
+      # TODO: Write general description for PERCENT
+      PERCENT = 'PERCENT'.freeze,
+
+      # TODO: Write general description for DOLLAR
+      DOLLAR = 'DOLLAR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FIXED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fixed' then FIXED
+      when 'percent' then PERCENT
+      when 'dollar' then DOLLAR
+      else
+        default_value
+      end
+    end
+  end
+end