apimatic-ak-sdk 0.0.1

data/lib/akoya/models/mutual_fund_security_entity.rb

@@ -0,0 +1,150 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Information about the mutual fund security specific to the type of security
+  class MutualFundSecurityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Mutual fund type
+    # @return [MutualFundType]
+    attr_accessor :mutual_fund_type
+
+    # Units in the FI's street name, positive quantity
+    # @return [Float]
+    attr_accessor :units_street
+
+    # Units in user's name directly, positive  quantity
+    # @return [Float]
+    attr_accessor :units_user
+
+    # Reinvest dividends
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reinvest_dividends
+
+    # Reinvest capital gains
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reinvest_capital_gains
+
+    # Current yield reported as portion of the fund's assets
+    # @return [Float]
+    attr_accessor :myield
+
+    # As-of date for yield value
+    # @return [DateTime]
+    attr_accessor :yield_as_of_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mutual_fund_type'] = 'mutualFundType'
+      @_hash['units_street'] = 'unitsStreet'
+      @_hash['units_user'] = 'unitsUser'
+      @_hash['reinvest_dividends'] = 'reinvestDividends'
+      @_hash['reinvest_capital_gains'] = 'reinvestCapitalGains'
+      @_hash['myield'] = 'yield'
+      @_hash['yield_as_of_date'] = 'yieldAsOfDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mutual_fund_type
+        units_street
+        units_user
+        reinvest_dividends
+        reinvest_capital_gains
+        myield
+        yield_as_of_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mutual_fund_type: SKIP, units_street: SKIP, units_user: SKIP,
+                   reinvest_dividends: SKIP, reinvest_capital_gains: SKIP,
+                   myield: SKIP, yield_as_of_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @mutual_fund_type = mutual_fund_type unless mutual_fund_type == SKIP
+      @units_street = units_street unless units_street == SKIP
+      @units_user = units_user unless units_user == SKIP
+      @reinvest_dividends = reinvest_dividends unless reinvest_dividends == SKIP
+      @reinvest_capital_gains = reinvest_capital_gains unless reinvest_capital_gains == SKIP
+      @myield = myield unless myield == SKIP
+      @yield_as_of_date = yield_as_of_date unless yield_as_of_date == 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.
+      mutual_fund_type =
+        hash.key?('mutualFundType') ? hash['mutualFundType'] : SKIP
+      units_street = hash.key?('unitsStreet') ? hash['unitsStreet'] : SKIP
+      units_user = hash.key?('unitsUser') ? hash['unitsUser'] : SKIP
+      reinvest_dividends =
+        hash.key?('reinvestDividends') ? hash['reinvestDividends'] : SKIP
+      reinvest_capital_gains =
+        hash.key?('reinvestCapitalGains') ? hash['reinvestCapitalGains'] : SKIP
+      myield = hash.key?('yield') ? hash['yield'] : SKIP
+      yield_as_of_date = if hash.key?('yieldAsOfDate')
+                           (DateTimeHelper.from_rfc3339(hash['yieldAsOfDate']) if hash['yieldAsOfDate'])
+                         else
+                           SKIP
+                         end
+
+      # 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.
+      MutualFundSecurityEntity.new(mutual_fund_type: mutual_fund_type,
+                                   units_street: units_street,
+                                   units_user: units_user,
+                                   reinvest_dividends: reinvest_dividends,
+                                   reinvest_capital_gains: reinvest_capital_gains,
+                                   myield: myield,
+                                   yield_as_of_date: yield_as_of_date,
+                                   additional_properties: additional_properties)
+    end
+
+    def to_custom_yield_as_of_date
+      DateTimeHelper.to_rfc3339(yield_as_of_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mutual_fund_type: #{@mutual_fund_type}, units_street: #{@units_street},"\
+      " units_user: #{@units_user}, reinvest_dividends: #{@reinvest_dividends},"\
+      " reinvest_capital_gains: #{@reinvest_capital_gains}, myield: #{@myield}, yield_as_of_date:"\
+      " #{@yield_as_of_date}, 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} mutual_fund_type: #{@mutual_fund_type.inspect}, units_street:"\
+      " #{@units_street.inspect}, units_user: #{@units_user.inspect}, reinvest_dividends:"\
+      " #{@reinvest_dividends.inspect}, reinvest_capital_gains:"\
+      " #{@reinvest_capital_gains.inspect}, myield: #{@myield.inspect}, yield_as_of_date:"\
+      " #{@yield_as_of_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/mutual_fund_type.rb

@@ -0,0 +1,40 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Mutual fund type
+  class MutualFundType
+    MUTUAL_FUND_TYPE = [
+      # TODO: Write general description for OPENEND
+      OPENEND = 'OPENEND'.freeze,
+
+      # TODO: Write general description for CLOSEEND
+      CLOSEEND = 'CLOSEEND'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = OPENEND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'openend' then OPENEND
+      when 'closeend' then CLOSEEND
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/obtain_tokens.rb

@@ -0,0 +1,99 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # The issued JWT will have an expiration that is set by the provider and will
+  # be valid only for the data permissioned by the end-user. Required:  -
+  # `grant_type`. Use `authorization_code` as the grant type. - `redirect_uri`.
+  # You must include your app's registered redirect uri. - `code`. To obtain id
+  # and refresh tokens, you must first obtain an authorization code. Pass it in
+  # the body of the request as code. Note, the code expires in 5 minutes.
+  class ObtainTokens < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Set to `authorization_code` to indicate an authorization code will be
+    # returned
+    # @return [String]
+    attr_accessor :grant_type
+
+    # URI where user will be redirected after end-users authorization is
+    # complete. It must be the same as the URI called in the authorization
+    # request
+    # @return [String]
+    attr_accessor :redirect_uri
+
+    # Authorization code from end-user's authentication.
+    # @return [String]
+    attr_accessor :code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['redirect_uri'] = 'redirect_uri'
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type: 'authorization_code', redirect_uri:, code:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grant_type = grant_type
+      @redirect_uri = redirect_uri
+      @code = code
+      @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.
+      grant_type = hash['grant_type'] ||= 'authorization_code'
+      redirect_uri = hash.key?('redirect_uri') ? hash['redirect_uri'] : nil
+      code = hash.key?('code') ? hash['code'] : nil
+
+      # 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.
+      ObtainTokens.new(grant_type: grant_type,
+                       redirect_uri: redirect_uri,
+                       code: code,
+                       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} grant_type: #{@grant_type}, redirect_uri: #{@redirect_uri}, code: #{@code},"\
+      " 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} grant_type: #{@grant_type.inspect}, redirect_uri: #{@redirect_uri.inspect},"\
+      " code: #{@code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/open_order_entity.rb

@@ -0,0 +1,228 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Information on an open order.
+  class OpenOrderEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long term persistent identity of the order. Id for this order transaction.
+    # @return [String]
+    attr_accessor :order_id
+
+    # Unique identifier of the security.
+    # @return [String]
+    attr_accessor :security_id
+
+    # Security identifier type
+    # @return [SecurityIdType]
+    attr_accessor :security_id_type
+
+    # Market symbol
+    # @return [String]
+    attr_accessor :symbol
+
+    # Description of order
+    # @return [String]
+    attr_accessor :description
+
+    # Number of units (shares, bonds, etc.)
+    # @return [Float]
+    attr_accessor :units
+
+    # Type of order.
+    # @return [OrderType]
+    attr_accessor :order_type
+
+    # Order date
+    # @return [DateTime]
+    attr_accessor :order_date
+
+    # Unit price
+    # @return [Float]
+    attr_accessor :unit_price
+
+    # Type of unit.
+    # @return [UnitTypeOpenOrderEntity]
+    attr_accessor :unit_type
+
+    # This order is good for DAY, GOODTILLCANCEL, IMMEDIATE
+    # @return [OrderDuration]
+    attr_accessor :order_duration
+
+    # This order is good for DAY, GOODTILLCANCEL, IMMEDIATE
+    # @return [SubAccount]
+    attr_accessor :sub_account
+
+    # Limit Price
+    # @return [Float]
+    attr_accessor :limit_price
+
+    # Stop price
+    # @return [Float]
+    attr_accessor :stop_price
+
+    # For 401(k) accounts, source of money for this order. Default if not
+    # present is OTHERNONVEST.
+    # @return [Inv401KSourceOpenOrderEntity]
+    attr_accessor :inv401k_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'orderId'
+      @_hash['security_id'] = 'securityId'
+      @_hash['security_id_type'] = 'securityIdType'
+      @_hash['symbol'] = 'symbol'
+      @_hash['description'] = 'description'
+      @_hash['units'] = 'units'
+      @_hash['order_type'] = 'orderType'
+      @_hash['order_date'] = 'orderDate'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['unit_type'] = 'unitType'
+      @_hash['order_duration'] = 'orderDuration'
+      @_hash['sub_account'] = 'subAccount'
+      @_hash['limit_price'] = 'limitPrice'
+      @_hash['stop_price'] = 'stopPrice'
+      @_hash['inv401k_source'] = 'inv401kSource'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        security_id
+        security_id_type
+        symbol
+        description
+        units
+        order_type
+        order_date
+        unit_price
+        unit_type
+        order_duration
+        sub_account
+        limit_price
+        stop_price
+        inv401k_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id: SKIP, security_id: SKIP, security_id_type: SKIP,
+                   symbol: SKIP, description: SKIP, units: SKIP,
+                   order_type: SKIP, order_date: SKIP, unit_price: SKIP,
+                   unit_type: SKIP, order_duration: SKIP, sub_account: SKIP,
+                   limit_price: SKIP, stop_price: SKIP, inv401k_source: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @order_id = order_id unless order_id == 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
+      @description = description unless description == SKIP
+      @units = units unless units == SKIP
+      @order_type = order_type unless order_type == SKIP
+      @order_date = order_date unless order_date == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @unit_type = unit_type unless unit_type == SKIP
+      @order_duration = order_duration unless order_duration == SKIP
+      @sub_account = sub_account unless sub_account == SKIP
+      @limit_price = limit_price unless limit_price == SKIP
+      @stop_price = stop_price unless stop_price == SKIP
+      @inv401k_source = inv401k_source unless inv401k_source == 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.
+      order_id = hash.key?('orderId') ? hash['orderId'] : 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
+      description = hash.key?('description') ? hash['description'] : SKIP
+      units = hash.key?('units') ? hash['units'] : SKIP
+      order_type = hash.key?('orderType') ? hash['orderType'] : SKIP
+      order_date = if hash.key?('orderDate')
+                     (DateTimeHelper.from_rfc3339(hash['orderDate']) if hash['orderDate'])
+                   else
+                     SKIP
+                   end
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+      unit_type = hash.key?('unitType') ? hash['unitType'] : SKIP
+      order_duration = hash.key?('orderDuration') ? hash['orderDuration'] : SKIP
+      sub_account = hash.key?('subAccount') ? hash['subAccount'] : SKIP
+      limit_price = hash.key?('limitPrice') ? hash['limitPrice'] : SKIP
+      stop_price = hash.key?('stopPrice') ? hash['stopPrice'] : SKIP
+      inv401k_source = hash.key?('inv401kSource') ? hash['inv401kSource'] : 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.
+      OpenOrderEntity.new(order_id: order_id,
+                          security_id: security_id,
+                          security_id_type: security_id_type,
+                          symbol: symbol,
+                          description: description,
+                          units: units,
+                          order_type: order_type,
+                          order_date: order_date,
+                          unit_price: unit_price,
+                          unit_type: unit_type,
+                          order_duration: order_duration,
+                          sub_account: sub_account,
+                          limit_price: limit_price,
+                          stop_price: stop_price,
+                          inv401k_source: inv401k_source,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_order_date
+      DateTimeHelper.to_rfc3339(order_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}, security_id: #{@security_id}, security_id_type:"\
+      " #{@security_id_type}, symbol: #{@symbol}, description: #{@description}, units: #{@units},"\
+      " order_type: #{@order_type}, order_date: #{@order_date}, unit_price: #{@unit_price},"\
+      " unit_type: #{@unit_type}, order_duration: #{@order_duration}, sub_account:"\
+      " #{@sub_account}, limit_price: #{@limit_price}, stop_price: #{@stop_price}, inv401k_source:"\
+      " #{@inv401k_source}, 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} order_id: #{@order_id.inspect}, security_id: #{@security_id.inspect},"\
+      " security_id_type: #{@security_id_type.inspect}, symbol: #{@symbol.inspect}, description:"\
+      " #{@description.inspect}, units: #{@units.inspect}, order_type: #{@order_type.inspect},"\
+      " order_date: #{@order_date.inspect}, unit_price: #{@unit_price.inspect}, unit_type:"\
+      " #{@unit_type.inspect}, order_duration: #{@order_duration.inspect}, sub_account:"\
+      " #{@sub_account.inspect}, limit_price: #{@limit_price.inspect}, stop_price:"\
+      " #{@stop_price.inspect}, inv401k_source: #{@inv401k_source.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/option_security.rb

@@ -0,0 +1,125 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # OptionSecurity Model.
+  class OptionSecurity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :expire_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :option_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :secured
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :strike_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['expire_date'] = 'expireDate'
+      @_hash['option_type'] = 'optionType'
+      @_hash['secured'] = 'secured'
+      @_hash['strike_price'] = 'strikePrice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expire_date
+        option_type
+        secured
+        strike_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(expire_date: SKIP, option_type: SKIP, secured: SKIP,
+                   strike_price: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @expire_date = expire_date unless expire_date == SKIP
+      @option_type = option_type unless option_type == SKIP
+      @secured = secured unless secured == SKIP
+      @strike_price = strike_price unless strike_price == 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.
+      expire_date = if hash.key?('expireDate')
+                      (DateTimeHelper.from_rfc3339(hash['expireDate']) if hash['expireDate'])
+                    else
+                      SKIP
+                    end
+      option_type = hash.key?('optionType') ? hash['optionType'] : SKIP
+      secured = hash.key?('secured') ? hash['secured'] : SKIP
+      strike_price = hash.key?('strikePrice') ? hash['strikePrice'] : 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.
+      OptionSecurity.new(expire_date: expire_date,
+                         option_type: option_type,
+                         secured: secured,
+                         strike_price: strike_price,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_expire_date
+      DateTimeHelper.to_rfc3339(expire_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OptionSecurity | 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} expire_date: #{@expire_date}, option_type: #{@option_type}, secured:"\
+      " #{@secured}, strike_price: #{@strike_price}, 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} expire_date: #{@expire_date.inspect}, option_type: #{@option_type.inspect},"\
+      " secured: #{@secured.inspect}, strike_price: #{@strike_price.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end