fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/scheduled_payment_entity.rb

@@ -0,0 +1,116 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A payment scheduled on the account
+  class ScheduledPaymentEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total payment due or next payment due. Monthly payment due for loans
+    # @return [Float]
+    attr_accessor :amount
+
+    # The date that the payment is due
+    # @return [Date]
+    attr_accessor :date
+
+    # Type of payment (`AUTOPAY`, `ONE_TIME`, `REPEATING`)
+    # @return [ScheduledPaymentType2]
+    attr_accessor :type
+
+    # Whether payment is applied to principal or not
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pay_to_principal
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['date'] = 'date'
+      @_hash['type'] = 'type'
+      @_hash['pay_to_principal'] = 'payToPrincipal'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        date
+        type
+        pay_to_principal
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, date: SKIP, type: SKIP, pay_to_principal: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @date = date unless date == SKIP
+      @type = type unless type == SKIP
+      @pay_to_principal = pay_to_principal unless pay_to_principal == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      date = hash.key?('date') ? hash['date'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      pay_to_principal =
+        hash.key?('payToPrincipal') ? hash['payToPrincipal'] : 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.
+      ScheduledPaymentEntity.new(amount: amount,
+                                 date: date,
+                                 type: type,
+                                 pay_to_principal: pay_to_principal,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ScheduledPaymentEntity | 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} amount: #{@amount}, date: #{@date}, type: #{@type}, pay_to_principal:"\
+      " #{@pay_to_principal}, 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} amount: #{@amount.inspect}, date: #{@date.inspect}, type: #{@type.inspect},"\
+      " pay_to_principal: #{@pay_to_principal.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/scheduled_payment_type.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The type of a payment scheduled on the account
+  class ScheduledPaymentType
+    SCHEDULED_PAYMENT_TYPE = [
+      # TODO: Write general description for AUTOPAY
+      AUTOPAY = 'AUTOPAY'.freeze,
+
+      # TODO: Write general description for ONE_TIME
+      ONE_TIME = 'ONE_TIME'.freeze,
+
+      # TODO: Write general description for REPEATING
+      REPEATING = 'REPEATING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AUTOPAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'autopay' then AUTOPAY
+      when 'one_time' then ONE_TIME
+      when 'repeating' then REPEATING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/scheduled_payment_type2.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of payment (`AUTOPAY`, `ONE_TIME`, `REPEATING`)
+  class ScheduledPaymentType2
+    SCHEDULED_PAYMENT_TYPE2 = [
+      # TODO: Write general description for AUTOPAY
+      AUTOPAY = 'AUTOPAY'.freeze,
+
+      # TODO: Write general description for ONE_TIME
+      ONE_TIME = 'ONE_TIME'.freeze,
+
+      # TODO: Write general description for REPEATING
+      REPEATING = 'REPEATING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AUTOPAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'autopay' then AUTOPAY
+      when 'one_time' then ONE_TIME
+      when 'repeating' then REPEATING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/secured.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # How the option is secured
+  class Secured
+    SECURED = [
+      # TODO: Write general description for COVERED
+      COVERED = 'COVERED'.freeze,
+
+      # TODO: Write general description for NAKED
+      NAKED = 'NAKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = COVERED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'covered' then COVERED
+      when 'naked' then NAKED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/secured2.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # How the option is secured. One of NAKED, COVERED
+  class Secured2
+    SECURED2 = [
+      # TODO: Write general description for COVERED
+      COVERED = 'COVERED'.freeze,
+
+      # TODO: Write general description for NAKED
+      NAKED = 'NAKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = COVERED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'covered' then COVERED
+      when 'naked' then NAKED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category.rb

@@ -0,0 +1,68 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The type of security
+  class SecurityCategory
+    SECURITY_CATEGORY = [
+      # TODO: Write general description for ANNUITY_SECURITY
+      ANNUITY_SECURITY = 'ANNUITY_SECURITY'.freeze,
+
+      # TODO: Write general description for BOND_SECURITY
+      BOND_SECURITY = 'BOND_SECURITY'.freeze,
+
+      # TODO: Write general description for CD_SECURITY
+      CD_SECURITY = 'CD_SECURITY'.freeze,
+
+      # TODO: Write general description for DEBT_SECURITY
+      DEBT_SECURITY = 'DEBT_SECURITY'.freeze,
+
+      # TODO: Write general description for DIGITAL_ASSET_SECURITY
+      DIGITAL_ASSET_SECURITY = 'DIGITAL_ASSET_SECURITY'.freeze,
+
+      # TODO: Write general description for MUTUAL_FUND_SECURITY
+      MUTUAL_FUND_SECURITY = 'MUTUAL_FUND_SECURITY'.freeze,
+
+      # TODO: Write general description for OPTION_SECURITY
+      OPTION_SECURITY = 'OPTION_SECURITY'.freeze,
+
+      # TODO: Write general description for OTHER_SECURITY
+      OTHER_SECURITY = 'OTHER_SECURITY'.freeze,
+
+      # TODO: Write general description for STOCK_SECURITY
+      STOCK_SECURITY = 'STOCK_SECURITY'.freeze,
+
+      # TODO: Write general description for SWEEP_SECURITY
+      SWEEP_SECURITY = 'SWEEP_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ANNUITY_SECURITY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'annuity_security' then ANNUITY_SECURITY
+      when 'bond_security' then BOND_SECURITY
+      when 'cd_security' then CD_SECURITY
+      when 'debt_security' then DEBT_SECURITY
+      when 'digital_asset_security' then DIGITAL_ASSET_SECURITY
+      when 'mutual_fund_security' then MUTUAL_FUND_SECURITY
+      when 'option_security' then OPTION_SECURITY
+      when 'other_security' then OTHER_SECURITY
+      when 'stock_security' then STOCK_SECURITY
+      when 'sweep_security' then SWEEP_SECURITY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category1.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case DEBT_SECURITY
+  class SecurityCategory1
+    SECURITY_CATEGORY1 = [
+      # TODO: Write general description for DEBT_SECURITY
+      DEBT_SECURITY = 'DEBT_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DEBT_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category11.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case ANNUITY_SECURITY
+  class SecurityCategory11
+    SECURITY_CATEGORY11 = [
+      # TODO: Write general description for ANNUITY_SECURITY
+      ANNUITY_SECURITY = 'ANNUITY_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ANNUITY_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category2.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case BOND_SECURITY
+  class SecurityCategory2
+    SECURITY_CATEGORY2 = [
+      # TODO: Write general description for BOND_SECURITY
+      BOND_SECURITY = 'BOND_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BOND_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category3.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case CD_SECURITY
+  class SecurityCategory3
+    SECURITY_CATEGORY3 = [
+      # TODO: Write general description for CD_SECURITY
+      CD_SECURITY = 'CD_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CD_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category4.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case DIGITAL_ASSET_SECURITY
+  class SecurityCategory4
+    SECURITY_CATEGORY4 = [
+      # TODO: Write general description for DIGITAL_ASSET_SECURITY
+      DIGITAL_ASSET_SECURITY = 'DIGITAL_ASSET_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DIGITAL_ASSET_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category5.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case MUTUAL_FUND_SECURITY
+  class SecurityCategory5
+    SECURITY_CATEGORY5 = [
+      # TODO: Write general description for MUTUAL_FUND_SECURITY
+      MUTUAL_FUND_SECURITY = 'MUTUAL_FUND_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MUTUAL_FUND_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category6.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case OPTION_SECURITY
+  class SecurityCategory6
+    SECURITY_CATEGORY6 = [
+      # TODO: Write general description for OPTION_SECURITY
+      OPTION_SECURITY = 'OPTION_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = OPTION_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category7.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case OTHER_SECURITY
+  class SecurityCategory7
+    SECURITY_CATEGORY7 = [
+      # TODO: Write general description for OTHER_SECURITY
+      OTHER_SECURITY = 'OTHER_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = OTHER_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category8.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case STOCK_SECURITY
+  class SecurityCategory8
+    SECURITY_CATEGORY8 = [
+      # TODO: Write general description for STOCK_SECURITY
+      STOCK_SECURITY = 'STOCK_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = STOCK_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/fdx_v660_api/models/security_category9.rb

@@ -0,0 +1,26 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The entity type of this security, in this case SWEEP_SECURITY
+  class SecurityCategory9
+    SECURITY_CATEGORY9 = [
+      # TODO: Write general description for SWEEP_SECURITY
+      SWEEP_SECURITY = 'SWEEP_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SWEEP_SECURITY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end