apimatic-ak-sdk 0.0.1

data/lib/akoya/models/option_security_entity.rb

@@ -0,0 +1,127 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Information about the option security specific to the type of security
+  class OptionSecurityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # How the option is secured
+    # @return [Secured]
+    attr_accessor :secured
+
+    # How the option is secured
+    # @return [OptionType]
+    attr_accessor :option_type
+
+    # Strike price / Unit price
+    # @return [Float]
+    attr_accessor :strike_price
+
+    # Expiration date of option
+    # @return [DateTime]
+    attr_accessor :expire_date
+
+    # Shares per contract
+    # @return [Float]
+    attr_accessor :shares_per_contract
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['secured'] = 'secured'
+      @_hash['option_type'] = 'optionType'
+      @_hash['strike_price'] = 'strikePrice'
+      @_hash['expire_date'] = 'expireDate'
+      @_hash['shares_per_contract'] = 'sharesPerContract'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        secured
+        option_type
+        strike_price
+        expire_date
+        shares_per_contract
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(secured: SKIP, option_type: SKIP, strike_price: SKIP,
+                   expire_date: SKIP, shares_per_contract: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @secured = secured unless secured == SKIP
+      @option_type = option_type unless option_type == SKIP
+      @strike_price = strike_price unless strike_price == SKIP
+      @expire_date = expire_date unless expire_date == SKIP
+      @shares_per_contract = shares_per_contract unless shares_per_contract == 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.
+      secured = hash.key?('secured') ? hash['secured'] : SKIP
+      option_type = hash.key?('optionType') ? hash['optionType'] : SKIP
+      strike_price = hash.key?('strikePrice') ? hash['strikePrice'] : SKIP
+      expire_date = if hash.key?('expireDate')
+                      (DateTimeHelper.from_rfc3339(hash['expireDate']) if hash['expireDate'])
+                    else
+                      SKIP
+                    end
+      shares_per_contract =
+        hash.key?('sharesPerContract') ? hash['sharesPerContract'] : 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.
+      OptionSecurityEntity.new(secured: secured,
+                               option_type: option_type,
+                               strike_price: strike_price,
+                               expire_date: expire_date,
+                               shares_per_contract: shares_per_contract,
+                               additional_properties: additional_properties)
+    end
+
+    def to_custom_expire_date
+      DateTimeHelper.to_rfc3339(expire_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} secured: #{@secured}, option_type: #{@option_type}, strike_price:"\
+      " #{@strike_price}, expire_date: #{@expire_date}, shares_per_contract:"\
+      " #{@shares_per_contract}, 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} secured: #{@secured.inspect}, option_type: #{@option_type.inspect},"\
+      " strike_price: #{@strike_price.inspect}, expire_date: #{@expire_date.inspect},"\
+      " shares_per_contract: #{@shares_per_contract.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/option_type.rb

@@ -0,0 +1,36 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # OptionType.
+  class OptionType
+    OPTION_TYPE = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'call' then CALL
+      when 'put' then PUT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/order_duration.rb

@@ -0,0 +1,40 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # This order is good for DAY, GOODTILLCANCEL, IMMEDIATE
+  class OrderDuration
+    ORDER_DURATION = [
+      # TODO: Write general description for DAY
+      DAY = 'DAY'.freeze,
+
+      # TODO: Write general description for GOODTILLCANCEL
+      GOODTILLCANCEL = 'GOODTILLCANCEL'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'IMMEDIATE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'goodtillcancel' then GOODTILLCANCEL
+      when 'immediate' then IMMEDIATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/order_type.rb

@@ -0,0 +1,60 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Type of order.
+  class OrderType
+    ORDER_TYPE = [
+      # TODO: Write general description for BUY
+      BUY = 'BUY'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'SELL'.freeze,
+
+      # TODO: Write general description for BUYTOCOVER
+      BUYTOCOVER = 'BUYTOCOVER'.freeze,
+
+      # TODO: Write general description for BUYTOOPEN
+      BUYTOOPEN = 'BUYTOOPEN'.freeze,
+
+      # TODO: Write general description for SELLTOCOVER
+      SELLTOCOVER = 'SELLTOCOVER'.freeze,
+
+      # TODO: Write general description for SELLTOOPEN
+      SELLTOOPEN = 'SELLTOOPEN'.freeze,
+
+      # TODO: Write general description for SELLSHORT
+      SELLSHORT = 'SELLSHORT'.freeze,
+
+      # TODO: Write general description for SELLCLOSE
+      SELLCLOSE = 'SELLCLOSE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BUY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'buy' then BUY
+      when 'sell' then SELL
+      when 'buytocover' then BUYTOCOVER
+      when 'buytoopen' then BUYTOOPEN
+      when 'selltocover' then SELLTOCOVER
+      when 'selltoopen' then SELLTOOPEN
+      when 'sellshort' then SELLSHORT
+      when 'sellclose' then SELLCLOSE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/other_security_entity.rb

@@ -0,0 +1,77 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Information about the security specific to the type of security
+  class OtherSecurityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Description of Other Security
+    # @return [String]
+    attr_accessor :type_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type_description'] = 'typeDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type_description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type_description = type_description unless type_description == 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.
+      type_description =
+        hash.key?('typeDescription') ? hash['typeDescription'] : 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.
+      OtherSecurityEntity.new(type_description: type_description,
+                              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} type_description: #{@type_description}, 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} type_description: #{@type_description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/paginated_array.rb

@@ -0,0 +1,75 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # PaginatedArray Model.
+  class PaginatedArray < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Links]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(links: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @links = links unless links == 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.
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # 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.
+      PaginatedArray.new(links: links,
+                         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} links: #{@links}, 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} links: #{@links.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/payment_details.rb

@@ -0,0 +1,142 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Payment details for some transactions
+  class PaymentDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount of payment applied to escrow
+    # @return [Float]
+    attr_accessor :escrow_amount
+
+    # The amount of payment applied to fees
+    # @return [Float]
+    attr_accessor :fees_amount
+
+    # The amount of payment applied to life/health/accident insurance on the
+    # loan
+    # @return [Float]
+    attr_accessor :insurance_amount
+
+    # The amount of payment applied to interest
+    # @return [Float]
+    attr_accessor :interest_amount
+
+    # The amount of payment applied to PMI
+    # @return [Float]
+    attr_accessor :pmi_amount
+
+    # The amount of payment applied to principal
+    # @return [Float]
+    attr_accessor :principal_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['escrow_amount'] = 'escrowAmount'
+      @_hash['fees_amount'] = 'feesAmount'
+      @_hash['insurance_amount'] = 'insuranceAmount'
+      @_hash['interest_amount'] = 'interestAmount'
+      @_hash['pmi_amount'] = 'pmiAmount'
+      @_hash['principal_amount'] = 'principalAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        escrow_amount
+        fees_amount
+        insurance_amount
+        interest_amount
+        pmi_amount
+        principal_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(escrow_amount: SKIP, fees_amount: SKIP,
+                   insurance_amount: SKIP, interest_amount: SKIP,
+                   pmi_amount: SKIP, principal_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @escrow_amount = escrow_amount unless escrow_amount == SKIP
+      @fees_amount = fees_amount unless fees_amount == SKIP
+      @insurance_amount = insurance_amount unless insurance_amount == SKIP
+      @interest_amount = interest_amount unless interest_amount == SKIP
+      @pmi_amount = pmi_amount unless pmi_amount == SKIP
+      @principal_amount = principal_amount unless principal_amount == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      escrow_amount = hash.key?('escrowAmount') ? hash['escrowAmount'] : SKIP
+      fees_amount = hash.key?('feesAmount') ? hash['feesAmount'] : SKIP
+      insurance_amount =
+        hash.key?('insuranceAmount') ? hash['insuranceAmount'] : SKIP
+      interest_amount =
+        hash.key?('interestAmount') ? hash['interestAmount'] : SKIP
+      pmi_amount = hash.key?('pmiAmount') ? hash['pmiAmount'] : SKIP
+      principal_amount =
+        hash.key?('principalAmount') ? hash['principalAmount'] : 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.
+      PaymentDetails.new(escrow_amount: escrow_amount,
+                         fees_amount: fees_amount,
+                         insurance_amount: insurance_amount,
+                         interest_amount: interest_amount,
+                         pmi_amount: pmi_amount,
+                         principal_amount: principal_amount,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentDetails | 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} escrow_amount: #{@escrow_amount}, fees_amount: #{@fees_amount},"\
+      " insurance_amount: #{@insurance_amount}, interest_amount: #{@interest_amount}, pmi_amount:"\
+      " #{@pmi_amount}, principal_amount: #{@principal_amount}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} escrow_amount: #{@escrow_amount.inspect}, fees_amount:"\
+      " #{@fees_amount.inspect}, insurance_amount: #{@insurance_amount.inspect}, interest_amount:"\
+      " #{@interest_amount.inspect}, pmi_amount: #{@pmi_amount.inspect}, principal_amount:"\
+      " #{@principal_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/payment_frequency.rb

@@ -0,0 +1,56 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # PaymentFrequency.
+  class PaymentFrequency
+    PAYMENT_FREQUENCY = [
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAILY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'daily' then DAILY
+      when 'weekly' then WEEKLY
+      when 'biweekly' then BIWEEKLY
+      when 'semimonthly' then SEMIMONTHLY
+      when 'monthly' then MONTHLY
+      when 'semiannually' then SEMIANNUALLY
+      when 'annually' then ANNUALLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/payment_frequency_annuity_account.rb

@@ -0,0 +1,44 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # PaymentFrequency_AnnuityAccount.
+  class PaymentFrequencyAnnuityAccount
+    PAYMENT_FREQUENCY_ANNUITY_ACCOUNT = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ANNUALLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'annually' then ANNUALLY
+      when 'quarterly' then QUARTERLY
+      when 'monthly' then MONTHLY
+      when 'weekly' then WEEKLY
+      else
+        default_value
+      end
+    end
+  end
+end