apimatic-ak-sdk 0.0.1

data/lib/akoya/models/us_bank_investment_holdings.rb

@@ -0,0 +1,403 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # UsBankInvestmentHoldings Model.
+  class UsBankInvestmentHoldings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AssetClass]]
+    attr_accessor :asset_classes
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :average_cost
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :change_in_price
+
+    # TODO: Write general description for this method
+    # @return [Currency]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :current_unit_price
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :current_unit_price_date
+
+    # TODO: Write general description for this method
+    # @return [DebtSecurity]
+    attr_accessor :debt_security
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [Array[FiAssetClass]]
+    attr_accessor :fi_asset_classes
+
+    # TODO: Write general description for this method
+    # @return [Array[FiAttribute]]
+    attr_accessor :fi_attributes
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :holding_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :holding_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :holding_type
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :market_value
+
+    # TODO: Write general description for this method
+    # @return [MutualFundSecurity]
+    attr_accessor :mutual_fund_security
+
+    # TODO: Write general description for this method
+    # @return [OptionSecurity]
+    attr_accessor :option_security
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :original_purchase_date
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :other_security
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :purchased_price
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :security_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :security_id_type
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :stock_security
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :sweep_security
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :symbol
+
+    # TODO: Write general description for this method
+    # @return [Array[TaxLot]]
+    attr_accessor :tax_lots
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :units
+
+    # 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['change_in_price'] = 'changeInPrice'
+      @_hash['currency'] = 'currency'
+      @_hash['current_unit_price'] = 'currentUnitPrice'
+      @_hash['current_unit_price_date'] = 'currentUnitPriceDate'
+      @_hash['debt_security'] = 'debtSecurity'
+      @_hash['description'] = 'description'
+      @_hash['fi_asset_classes'] = 'fiAssetClasses'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash['holding_id'] = 'holdingId'
+      @_hash['holding_name'] = 'holdingName'
+      @_hash['holding_type'] = 'holdingType'
+      @_hash['market_value'] = 'marketValue'
+      @_hash['mutual_fund_security'] = 'mutualFundSecurity'
+      @_hash['option_security'] = 'optionSecurity'
+      @_hash['original_purchase_date'] = 'originalPurchaseDate'
+      @_hash['other_security'] = 'otherSecurity'
+      @_hash['purchased_price'] = 'purchasedPrice'
+      @_hash['security_id'] = 'securityId'
+      @_hash['security_id_type'] = 'securityIdType'
+      @_hash['stock_security'] = 'stockSecurity'
+      @_hash['sweep_security'] = 'sweepSecurity'
+      @_hash['symbol'] = 'symbol'
+      @_hash['tax_lots'] = 'taxLots'
+      @_hash['units'] = 'units'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_classes
+        average_cost
+        change_in_price
+        currency
+        current_unit_price
+        current_unit_price_date
+        debt_security
+        description
+        fi_asset_classes
+        fi_attributes
+        holding_id
+        holding_name
+        holding_type
+        market_value
+        mutual_fund_security
+        option_security
+        original_purchase_date
+        other_security
+        purchased_price
+        security_id
+        security_id_type
+        stock_security
+        sweep_security
+        symbol
+        tax_lots
+        units
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_classes: SKIP, average_cost: SKIP,
+                   change_in_price: SKIP, currency: SKIP,
+                   current_unit_price: SKIP, current_unit_price_date: SKIP,
+                   debt_security: SKIP, description: SKIP,
+                   fi_asset_classes: SKIP, fi_attributes: SKIP,
+                   holding_id: SKIP, holding_name: SKIP, holding_type: SKIP,
+                   market_value: SKIP, mutual_fund_security: SKIP,
+                   option_security: SKIP, original_purchase_date: SKIP,
+                   other_security: SKIP, purchased_price: SKIP,
+                   security_id: SKIP, security_id_type: SKIP,
+                   stock_security: SKIP, sweep_security: SKIP, symbol: SKIP,
+                   tax_lots: SKIP, units: 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
+      @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
+      @debt_security = debt_security unless debt_security == SKIP
+      @description = description unless description == SKIP
+      @fi_asset_classes = fi_asset_classes unless fi_asset_classes == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == SKIP
+      @holding_id = holding_id unless holding_id == SKIP
+      @holding_name = holding_name unless holding_name == SKIP
+      @holding_type = holding_type unless holding_type == SKIP
+      @market_value = market_value unless market_value == SKIP
+      @mutual_fund_security = mutual_fund_security unless mutual_fund_security == SKIP
+      @option_security = option_security unless option_security == SKIP
+      @original_purchase_date = original_purchase_date unless original_purchase_date == SKIP
+      @other_security = other_security unless other_security == SKIP
+      @purchased_price = purchased_price unless purchased_price == SKIP
+      @security_id = security_id unless security_id == SKIP
+      @security_id_type = security_id_type unless security_id_type == SKIP
+      @stock_security = stock_security unless stock_security == SKIP
+      @sweep_security = sweep_security unless sweep_security == SKIP
+      @symbol = symbol unless symbol == SKIP
+      @tax_lots = tax_lots unless tax_lots == SKIP
+      @units = units unless units == 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 << (AssetClass.from_hash(structure) if structure)
+        end
+      end
+
+      asset_classes = SKIP unless hash.key?('assetClasses')
+      average_cost = hash.key?('averageCost') ? hash['averageCost'] : SKIP
+      change_in_price =
+        hash.key?('changeInPrice') ? hash['changeInPrice'] : SKIP
+      currency = Currency.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
+      debt_security = DebtSecurity.from_hash(hash['debtSecurity']) if hash['debtSecurity']
+      description = hash.key?('description') ? hash['description'] : 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 << (FiAssetClass.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 << (FiAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+      holding_id = hash.key?('holdingId') ? hash['holdingId'] : SKIP
+      holding_name = hash.key?('holdingName') ? hash['holdingName'] : SKIP
+      holding_type = hash.key?('holdingType') ? hash['holdingType'] : SKIP
+      market_value = hash.key?('marketValue') ? hash['marketValue'] : SKIP
+      mutual_fund_security = MutualFundSecurity.from_hash(hash['mutualFundSecurity']) if
+        hash['mutualFundSecurity']
+      option_security = OptionSecurity.from_hash(hash['optionSecurity']) if hash['optionSecurity']
+      original_purchase_date = if hash.key?('originalPurchaseDate')
+                                 (DateTimeHelper.from_rfc3339(hash['originalPurchaseDate']) if hash['originalPurchaseDate'])
+                               else
+                                 SKIP
+                               end
+      other_security = hash.key?('otherSecurity') ? hash['otherSecurity'] : SKIP
+      purchased_price =
+        hash.key?('purchasedPrice') ? hash['purchasedPrice'] : SKIP
+      security_id = hash.key?('securityId') ? hash['securityId'] : SKIP
+      security_id_type =
+        hash.key?('securityIdType') ? hash['securityIdType'] : SKIP
+      stock_security = hash.key?('stockSecurity') ? hash['stockSecurity'] : SKIP
+      sweep_security = hash.key?('sweepSecurity') ? hash['sweepSecurity'] : 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 << (TaxLot.from_hash(structure) if structure)
+        end
+      end
+
+      tax_lots = SKIP unless hash.key?('taxLots')
+      units = hash.key?('units') ? hash['units'] : 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.
+      UsBankInvestmentHoldings.new(asset_classes: asset_classes,
+                                   average_cost: average_cost,
+                                   change_in_price: change_in_price,
+                                   currency: currency,
+                                   current_unit_price: current_unit_price,
+                                   current_unit_price_date: current_unit_price_date,
+                                   debt_security: debt_security,
+                                   description: description,
+                                   fi_asset_classes: fi_asset_classes,
+                                   fi_attributes: fi_attributes,
+                                   holding_id: holding_id,
+                                   holding_name: holding_name,
+                                   holding_type: holding_type,
+                                   market_value: market_value,
+                                   mutual_fund_security: mutual_fund_security,
+                                   option_security: option_security,
+                                   original_purchase_date: original_purchase_date,
+                                   other_security: other_security,
+                                   purchased_price: purchased_price,
+                                   security_id: security_id,
+                                   security_id_type: security_id_type,
+                                   stock_security: stock_security,
+                                   sweep_security: sweep_security,
+                                   symbol: symbol,
+                                   tax_lots: tax_lots,
+                                   units: units,
+                                   additional_properties: additional_properties)
+    end
+
+    def to_custom_current_unit_price_date
+      DateTimeHelper.to_rfc3339(current_unit_price_date)
+    end
+
+    def to_custom_original_purchase_date
+      DateTimeHelper.to_rfc3339(original_purchase_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UsBankInvestmentHoldings | 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} asset_classes: #{@asset_classes}, average_cost: #{@average_cost},"\
+      " change_in_price: #{@change_in_price}, currency: #{@currency}, current_unit_price:"\
+      " #{@current_unit_price}, current_unit_price_date: #{@current_unit_price_date},"\
+      " debt_security: #{@debt_security}, description: #{@description}, fi_asset_classes:"\
+      " #{@fi_asset_classes}, fi_attributes: #{@fi_attributes}, holding_id: #{@holding_id},"\
+      " holding_name: #{@holding_name}, holding_type: #{@holding_type}, market_value:"\
+      " #{@market_value}, mutual_fund_security: #{@mutual_fund_security}, option_security:"\
+      " #{@option_security}, original_purchase_date: #{@original_purchase_date}, other_security:"\
+      " #{@other_security}, purchased_price: #{@purchased_price}, security_id: #{@security_id},"\
+      " security_id_type: #{@security_id_type}, stock_security: #{@stock_security},"\
+      " sweep_security: #{@sweep_security}, symbol: #{@symbol}, tax_lots: #{@tax_lots}, units:"\
+      " #{@units}, 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}, 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}, debt_security:"\
+      " #{@debt_security.inspect}, description: #{@description.inspect}, fi_asset_classes:"\
+      " #{@fi_asset_classes.inspect}, fi_attributes: #{@fi_attributes.inspect}, holding_id:"\
+      " #{@holding_id.inspect}, holding_name: #{@holding_name.inspect}, holding_type:"\
+      " #{@holding_type.inspect}, market_value: #{@market_value.inspect}, mutual_fund_security:"\
+      " #{@mutual_fund_security.inspect}, option_security: #{@option_security.inspect},"\
+      " original_purchase_date: #{@original_purchase_date.inspect}, other_security:"\
+      " #{@other_security.inspect}, purchased_price: #{@purchased_price.inspect}, security_id:"\
+      " #{@security_id.inspect}, security_id_type: #{@security_id_type.inspect}, stock_security:"\
+      " #{@stock_security.inspect}, sweep_security: #{@sweep_security.inspect}, symbol:"\
+      " #{@symbol.inspect}, tax_lots: #{@tax_lots.inspect}, units: #{@units.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/vesting.rb

@@ -0,0 +1,135 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Vesting Model.
+  class Vesting < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Vested quantity (Vested shares total qty of vesting tranche)
+    # @return [Float]
+    attr_accessor :vested_quantity
+
+    # Vested balance at grant (aggregate of all vestings)
+    # @return [Float]
+    attr_accessor :vested_value
+
+    # Vested balance at grant (aggregate of all vestings)
+    # @return [DateTime]
+    attr_accessor :vesting_date
+
+    # Vested balance at grant (aggregate of all vestings)
+    # @return [DateTime]
+    attr_accessor :vest_expire_date
+
+    # Vested balance at grant (aggregate of all vestings)
+    # @return [String]
+    attr_accessor :vested_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vested_quantity'] = 'vestedQuantity'
+      @_hash['vested_value'] = 'vestedValue'
+      @_hash['vesting_date'] = 'vestingDate'
+      @_hash['vest_expire_date'] = 'vestExpireDate'
+      @_hash['vested_status'] = 'vestedStatus'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        vested_quantity
+        vested_value
+        vesting_date
+        vest_expire_date
+        vested_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(vested_quantity: SKIP, vested_value: SKIP,
+                   vesting_date: SKIP, vest_expire_date: SKIP,
+                   vested_status: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @vested_quantity = vested_quantity unless vested_quantity == SKIP
+      @vested_value = vested_value unless vested_value == SKIP
+      @vesting_date = vesting_date unless vesting_date == SKIP
+      @vest_expire_date = vest_expire_date unless vest_expire_date == SKIP
+      @vested_status = vested_status unless vested_status == 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.
+      vested_quantity =
+        hash.key?('vestedQuantity') ? hash['vestedQuantity'] : SKIP
+      vested_value = hash.key?('vestedValue') ? hash['vestedValue'] : SKIP
+      vesting_date = if hash.key?('vestingDate')
+                       (DateTimeHelper.from_rfc3339(hash['vestingDate']) if hash['vestingDate'])
+                     else
+                       SKIP
+                     end
+      vest_expire_date = if hash.key?('vestExpireDate')
+                           (DateTimeHelper.from_rfc3339(hash['vestExpireDate']) if hash['vestExpireDate'])
+                         else
+                           SKIP
+                         end
+      vested_status = hash.key?('vestedStatus') ? hash['vestedStatus'] : 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.
+      Vesting.new(vested_quantity: vested_quantity,
+                  vested_value: vested_value,
+                  vesting_date: vesting_date,
+                  vest_expire_date: vest_expire_date,
+                  vested_status: vested_status,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_vesting_date
+      DateTimeHelper.to_rfc3339(vesting_date)
+    end
+
+    def to_custom_vest_expire_date
+      DateTimeHelper.to_rfc3339(vest_expire_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} vested_quantity: #{@vested_quantity}, vested_value: #{@vested_value},"\
+      " vesting_date: #{@vesting_date}, vest_expire_date: #{@vest_expire_date}, vested_status:"\
+      " #{@vested_status}, 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} vested_quantity: #{@vested_quantity.inspect}, vested_value:"\
+      " #{@vested_value.inspect}, vesting_date: #{@vesting_date.inspect}, vest_expire_date:"\
+      " #{@vest_expire_date.inspect}, vested_status: #{@vested_status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end