fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/holding_type.rb

@@ -0,0 +1,51 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of an investment holding   | Value | Description |   |-----|-----|
+  #  | ANNUITY | Financial product that pays out a fixed stream of payments |
+  # | BOND | Debt security as a loan to a government, agency or company, repaid
+  # with interest |   | CD | Certificate of Deposit, a savings account with a
+  # fixed rate and term |   | DIGITALASSET | Digital representation of an asset
+  # or right that is stored and transferred on a digital network such as the
+  # internet or a blockchain |   | MUTUALFUND | Pooled collection of assets
+  # invested in stocks, bonds, and other securities |   | OPTION | The right to
+  # buy a specific number of stock shares at a pre-set price |   | OTHER |
+  # Another type of holding not listed here |   | STOCK | A share in the
+  # ownership of a company |
+  class HoldingType
+    HOLDING_TYPE = [
+      # TODO: Write general description for ANNUITY
+      ANNUITY = 'ANNUITY'.freeze,
+
+      # TODO: Write general description for BOND
+      BOND = 'BOND'.freeze,
+
+      # TODO: Write general description for CD
+      CD = 'CD'.freeze,
+
+      # TODO: Write general description for DIGITALASSET
+      DIGITALASSET = 'DIGITALASSET'.freeze,
+
+      # TODO: Write general description for MUTUALFUND
+      MUTUALFUND = 'MUTUALFUND'.freeze,
+
+      # TODO: Write general description for OPTION
+      OPTION = 'OPTION'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for STOCK
+      STOCK = 'STOCK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/holding_type2.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # ANNUITY, BOND, CD, DIGITALASSET, MUTUALFUND, OPTION, OTHER, STOCK
+  class HoldingType2
+    HOLDING_TYPE2 = [
+      # TODO: Write general description for ANNUITY
+      ANNUITY = 'ANNUITY'.freeze,
+
+      # TODO: Write general description for BOND
+      BOND = 'BOND'.freeze,
+
+      # TODO: Write general description for CD
+      CD = 'CD'.freeze,
+
+      # TODO: Write general description for DIGITALASSET
+      DIGITALASSET = 'DIGITALASSET'.freeze,
+
+      # TODO: Write general description for MUTUALFUND
+      MUTUALFUND = 'MUTUALFUND'.freeze,
+
+      # TODO: Write general description for OPTION
+      OPTION = 'OPTION'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for STOCK
+      STOCK = 'STOCK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/http_action_type.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # HTTP Method to use for the request
+  class HttpActionType
+    HTTP_ACTION_TYPE = [
+      # TODO: Write general description for DELETE
+      DELETE = 'DELETE'.freeze,
+
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze,
+
+      # TODO: Write general description for PATCH
+      PATCH = 'PATCH'.freeze,
+
+      # TODO: Write general description for POST
+      POST = 'POST'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/iban2007_identifier_entity.rb

@@ -0,0 +1,86 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # IBAN 2007 account identifier
+  class Iban2007IdentifierEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Value of the account identifier
+    # @return [String]
+    attr_accessor :iban2007_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['iban2007_id'] = 'iban2007Id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        iban2007_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(iban2007_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @iban2007_id = iban2007_id unless iban2007_id == 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.
+      iban2007_id = hash.key?('iban2007Id') ? hash['iban2007Id'] : 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.
+      Iban2007IdentifierEntity.new(iban2007_id: iban2007_id,
+                                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Iban2007IdentifierEntity | 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} iban2007_id: #{@iban2007_id}, 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} iban2007_id: #{@iban2007_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/income.rb

@@ -0,0 +1,124 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Provides a person's employment income details. Applicable only for VOIE
+  # (Verification of Income and Employment) data retrieval
+  class Income < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The employee's base payroll rate
+    # @return [BasePayrollRate1]
+    attr_accessor :base_rate
+
+    # The frequency of payments
+    # @return [PayrollFrequencyType2]
+    attr_accessor :payroll_frequency
+
+    # The date of employee's most recent pay
+    # @return [Date]
+    attr_accessor :latest_pay_date
+
+    # The end date of employee's most recent pay period
+    # @return [Date]
+    attr_accessor :latest_pay_period_end_date
+
+    # Year-to-date pay for current year and total annual pay for previous years
+    # @return [PaymentAmounts1]
+    attr_accessor :annual_pay
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['base_rate'] = 'baseRate'
+      @_hash['payroll_frequency'] = 'payrollFrequency'
+      @_hash['latest_pay_date'] = 'latestPayDate'
+      @_hash['latest_pay_period_end_date'] = 'latestPayPeriodEndDate'
+      @_hash['annual_pay'] = 'annualPay'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        base_rate
+        latest_pay_date
+        latest_pay_period_end_date
+        annual_pay
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payroll_frequency:, base_rate: SKIP, latest_pay_date: SKIP,
+                   latest_pay_period_end_date: SKIP, annual_pay: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @base_rate = base_rate unless base_rate == SKIP
+      @payroll_frequency = payroll_frequency
+      @latest_pay_date = latest_pay_date unless latest_pay_date == SKIP
+      unless latest_pay_period_end_date == SKIP
+        @latest_pay_period_end_date =
+          latest_pay_period_end_date
+      end
+      @annual_pay = annual_pay unless annual_pay == 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.
+      payroll_frequency =
+        hash.key?('payrollFrequency') ? hash['payrollFrequency'] : nil
+      base_rate = BasePayrollRate1.from_hash(hash['baseRate']) if hash['baseRate']
+      latest_pay_date =
+        hash.key?('latestPayDate') ? hash['latestPayDate'] : SKIP
+      latest_pay_period_end_date =
+        hash.key?('latestPayPeriodEndDate') ? hash['latestPayPeriodEndDate'] : SKIP
+      annual_pay = PaymentAmounts1.from_hash(hash['annualPay']) if hash['annualPay']
+
+      # 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.
+      Income.new(payroll_frequency: payroll_frequency,
+                 base_rate: base_rate,
+                 latest_pay_date: latest_pay_date,
+                 latest_pay_period_end_date: latest_pay_period_end_date,
+                 annual_pay: annual_pay,
+                 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} base_rate: #{@base_rate}, payroll_frequency: #{@payroll_frequency},"\
+      " latest_pay_date: #{@latest_pay_date}, latest_pay_period_end_date:"\
+      " #{@latest_pay_period_end_date}, annual_pay: #{@annual_pay}, 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} base_rate: #{@base_rate.inspect}, payroll_frequency:"\
+      " #{@payroll_frequency.inspect}, latest_pay_date: #{@latest_pay_date.inspect},"\
+      " latest_pay_period_end_date: #{@latest_pay_period_end_date.inspect}, annual_pay:"\
+      " #{@annual_pay.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/income_type.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of income of an investment transaction
+  class IncomeType
+    INCOME_TYPE = [
+      # TODO: Write general description for CGLONG
+      CGLONG = 'CGLONG'.freeze,
+
+      # TODO: Write general description for CGSHORT
+      CGSHORT = 'CGSHORT'.freeze,
+
+      # TODO: Write general description for MISC
+      MISC = 'MISC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/income_type2.rb

@@ -0,0 +1,27 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of investment income. One of CGLONG (capital gains-long term), CGSHORT
+  # (capital gains-short term), MISC
+  class IncomeType2
+    INCOME_TYPE2 = [
+      # TODO: Write general description for CGLONG
+      CGLONG = 'CGLONG'.freeze,
+
+      # TODO: Write general description for CGSHORT
+      CGSHORT = 'CGSHORT'.freeze,
+
+      # TODO: Write general description for MISC
+      MISC = 'MISC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/incoming_and_outgoing_transfer_limits.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The amount limits for incoming and outgoing transfers
+  class IncomingAndOutgoingTransferLimits < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Limits for outgoing transfers from the account
+    # @return [TimeAndOccurrenceBasedTransferLimits3]
+    attr_accessor :out
+
+    # Limits for incoming transfers to the account
+    # @return [TimeAndOccurrenceBasedTransferLimits1]
+    attr_accessor :min
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['out'] = 'out'
+      @_hash['min'] = 'in'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        out
+        min
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(out: SKIP, min: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @out = out unless out == SKIP
+      @min = min unless min == 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.
+      out = TimeAndOccurrenceBasedTransferLimits3.from_hash(hash['out']) if hash['out']
+      min = TimeAndOccurrenceBasedTransferLimits1.from_hash(hash['in']) if hash['in']
+
+      # 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.
+      IncomingAndOutgoingTransferLimits.new(out: out,
+                                            min: min,
+                                            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} out: #{@out}, min: #{@min}, 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} out: #{@out.inspect}, min: #{@min.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/incoming_and_outgoing_transfer_limits2.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The amount limits for transfers
+  class IncomingAndOutgoingTransferLimits2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Limits for outgoing transfers from the account
+    # @return [TimeAndOccurrenceBasedTransferLimits3]
+    attr_accessor :out
+
+    # Limits for incoming transfers to the account
+    # @return [TimeAndOccurrenceBasedTransferLimits1]
+    attr_accessor :min
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['out'] = 'out'
+      @_hash['min'] = 'in'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        out
+        min
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(out: SKIP, min: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @out = out unless out == SKIP
+      @min = min unless min == 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.
+      out = TimeAndOccurrenceBasedTransferLimits3.from_hash(hash['out']) if hash['out']
+      min = TimeAndOccurrenceBasedTransferLimits1.from_hash(hash['in']) if hash['in']
+
+      # 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.
+      IncomingAndOutgoingTransferLimits2.new(out: out,
+                                             min: min,
+                                             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} out: #{@out}, min: #{@min}, 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} out: #{@out.inspect}, min: #{@min.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/individual_name.rb

@@ -0,0 +1,115 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # First name, middle initial, last name, suffix fields
+  class IndividualName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # First name
+    # @return [String]
+    attr_accessor :first
+
+    # Middle initial
+    # @return [String]
+    attr_accessor :middle
+
+    # Last name
+    # @return [String]
+    attr_accessor :last
+
+    # Generational or academic suffix
+    # @return [String]
+    attr_accessor :suffix
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first'] = 'first'
+      @_hash['middle'] = 'middle'
+      @_hash['last'] = 'last'
+      @_hash['suffix'] = 'suffix'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first
+        middle
+        last
+        suffix
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first: SKIP, middle: SKIP, last: SKIP, suffix: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @first = first unless first == SKIP
+      @middle = middle unless middle == SKIP
+      @last = last unless last == SKIP
+      @suffix = suffix unless suffix == 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.
+      first = hash.key?('first') ? hash['first'] : SKIP
+      middle = hash.key?('middle') ? hash['middle'] : SKIP
+      last = hash.key?('last') ? hash['last'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : 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.
+      IndividualName.new(first: first,
+                         middle: middle,
+                         last: last,
+                         suffix: suffix,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IndividualName | 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} first: #{@first}, middle: #{@middle}, last: #{@last}, suffix: #{@suffix},"\
+      " 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} first: #{@first.inspect}, middle: #{@middle.inspect}, last:"\
+      " #{@last.inspect}, suffix: #{@suffix.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end