fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/contribution_entity.rb

@@ -0,0 +1,275 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Contribution information to an investment account
+  class ContributionEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of security
+    # @return [String]
+    attr_accessor :security_id
+
+    # CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN
+    # @return [SecurityIdType1]
+    attr_accessor :security_id_type
+
+    # Employer contribution match percentage
+    # @return [Float]
+    attr_accessor :employer_match_percentage
+
+    # Employer contribution match amount
+    # @return [Float]
+    attr_accessor :employer_match_amount
+
+    # Employee pre-tax contribution amount
+    # @return [Float]
+    attr_accessor :employee_pre_tax_amount
+
+    # Employee pre-tax contribution percentage
+    # @return [Float]
+    attr_accessor :employee_pre_tax_percentage
+
+    # Employee after tax contribution amount
+    # @return [Float]
+    attr_accessor :employee_after_tax_amount
+
+    # Employee after tax contribution percentage
+    # @return [Float]
+    attr_accessor :employee_after_tax_percentage
+
+    # Employee defer pre-tax contribution match amount
+    # @return [Float]
+    attr_accessor :employee_defer_pre_tax_amount
+
+    # Employee defer pre-tax contribution match percentage
+    # @return [Float]
+    attr_accessor :employee_defer_pre_tax_percentage
+
+    # Employee total year to date contribution
+    # @return [Float]
+    attr_accessor :employee_year_to_date
+
+    # Employer total year to date contribution
+    # @return [Float]
+    attr_accessor :employer_year_to_date
+
+    # Rollover contribution percentage
+    # @return [Float]
+    attr_accessor :rollover_contribution_percentage
+
+    # Rollover contribution Amount
+    # @return [Float]
+    attr_accessor :rollover_contribution_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['security_id'] = 'securityId'
+      @_hash['security_id_type'] = 'securityIdType'
+      @_hash['employer_match_percentage'] = 'employerMatchPercentage'
+      @_hash['employer_match_amount'] = 'employerMatchAmount'
+      @_hash['employee_pre_tax_amount'] = 'employeePreTaxAmount'
+      @_hash['employee_pre_tax_percentage'] = 'employeePreTaxPercentage'
+      @_hash['employee_after_tax_amount'] = 'employeeAfterTaxAmount'
+      @_hash['employee_after_tax_percentage'] = 'employeeAfterTaxPercentage'
+      @_hash['employee_defer_pre_tax_amount'] = 'employeeDeferPreTaxAmount'
+      @_hash['employee_defer_pre_tax_percentage'] =
+        'employeeDeferPreTaxPercentage'
+      @_hash['employee_year_to_date'] = 'employeeYearToDate'
+      @_hash['employer_year_to_date'] = 'employerYearToDate'
+      @_hash['rollover_contribution_percentage'] =
+        'rolloverContributionPercentage'
+      @_hash['rollover_contribution_amount'] = 'rolloverContributionAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        security_id
+        security_id_type
+        employer_match_percentage
+        employer_match_amount
+        employee_pre_tax_amount
+        employee_pre_tax_percentage
+        employee_after_tax_amount
+        employee_after_tax_percentage
+        employee_defer_pre_tax_amount
+        employee_defer_pre_tax_percentage
+        employee_year_to_date
+        employer_year_to_date
+        rollover_contribution_percentage
+        rollover_contribution_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(security_id: SKIP, security_id_type: SKIP,
+                   employer_match_percentage: SKIP, employer_match_amount: SKIP,
+                   employee_pre_tax_amount: SKIP,
+                   employee_pre_tax_percentage: SKIP,
+                   employee_after_tax_amount: SKIP,
+                   employee_after_tax_percentage: SKIP,
+                   employee_defer_pre_tax_amount: SKIP,
+                   employee_defer_pre_tax_percentage: SKIP,
+                   employee_year_to_date: SKIP, employer_year_to_date: SKIP,
+                   rollover_contribution_percentage: SKIP,
+                   rollover_contribution_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @security_id = security_id unless security_id == SKIP
+      @security_id_type = security_id_type unless security_id_type == SKIP
+      unless employer_match_percentage == SKIP
+        @employer_match_percentage =
+          employer_match_percentage
+      end
+      @employer_match_amount = employer_match_amount unless employer_match_amount == SKIP
+      @employee_pre_tax_amount = employee_pre_tax_amount unless employee_pre_tax_amount == SKIP
+      unless employee_pre_tax_percentage == SKIP
+        @employee_pre_tax_percentage =
+          employee_pre_tax_percentage
+      end
+      unless employee_after_tax_amount == SKIP
+        @employee_after_tax_amount =
+          employee_after_tax_amount
+      end
+      unless employee_after_tax_percentage == SKIP
+        @employee_after_tax_percentage =
+          employee_after_tax_percentage
+      end
+      unless employee_defer_pre_tax_amount == SKIP
+        @employee_defer_pre_tax_amount =
+          employee_defer_pre_tax_amount
+      end
+      unless employee_defer_pre_tax_percentage == SKIP
+        @employee_defer_pre_tax_percentage =
+          employee_defer_pre_tax_percentage
+      end
+      @employee_year_to_date = employee_year_to_date unless employee_year_to_date == SKIP
+      @employer_year_to_date = employer_year_to_date unless employer_year_to_date == SKIP
+      unless rollover_contribution_percentage == SKIP
+        @rollover_contribution_percentage =
+          rollover_contribution_percentage
+      end
+      unless rollover_contribution_amount == SKIP
+        @rollover_contribution_amount =
+          rollover_contribution_amount
+      end
+      @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.
+      security_id = hash.key?('securityId') ? hash['securityId'] : SKIP
+      security_id_type =
+        hash.key?('securityIdType') ? hash['securityIdType'] : SKIP
+      employer_match_percentage =
+        hash.key?('employerMatchPercentage') ? hash['employerMatchPercentage'] : SKIP
+      employer_match_amount =
+        hash.key?('employerMatchAmount') ? hash['employerMatchAmount'] : SKIP
+      employee_pre_tax_amount =
+        hash.key?('employeePreTaxAmount') ? hash['employeePreTaxAmount'] : SKIP
+      employee_pre_tax_percentage =
+        hash.key?('employeePreTaxPercentage') ? hash['employeePreTaxPercentage'] : SKIP
+      employee_after_tax_amount =
+        hash.key?('employeeAfterTaxAmount') ? hash['employeeAfterTaxAmount'] : SKIP
+      employee_after_tax_percentage =
+        hash.key?('employeeAfterTaxPercentage') ? hash['employeeAfterTaxPercentage'] : SKIP
+      employee_defer_pre_tax_amount =
+        hash.key?('employeeDeferPreTaxAmount') ? hash['employeeDeferPreTaxAmount'] : SKIP
+      employee_defer_pre_tax_percentage =
+        hash.key?('employeeDeferPreTaxPercentage') ? hash['employeeDeferPreTaxPercentage'] : SKIP
+      employee_year_to_date =
+        hash.key?('employeeYearToDate') ? hash['employeeYearToDate'] : SKIP
+      employer_year_to_date =
+        hash.key?('employerYearToDate') ? hash['employerYearToDate'] : SKIP
+      rollover_contribution_percentage =
+        hash.key?('rolloverContributionPercentage') ? hash['rolloverContributionPercentage'] : SKIP
+      rollover_contribution_amount =
+        hash.key?('rolloverContributionAmount') ? hash['rolloverContributionAmount'] : 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.
+      ContributionEntity.new(security_id: security_id,
+                             security_id_type: security_id_type,
+                             employer_match_percentage: employer_match_percentage,
+                             employer_match_amount: employer_match_amount,
+                             employee_pre_tax_amount: employee_pre_tax_amount,
+                             employee_pre_tax_percentage: employee_pre_tax_percentage,
+                             employee_after_tax_amount: employee_after_tax_amount,
+                             employee_after_tax_percentage: employee_after_tax_percentage,
+                             employee_defer_pre_tax_amount: employee_defer_pre_tax_amount,
+                             employee_defer_pre_tax_percentage: employee_defer_pre_tax_percentage,
+                             employee_year_to_date: employee_year_to_date,
+                             employer_year_to_date: employer_year_to_date,
+                             rollover_contribution_percentage: rollover_contribution_percentage,
+                             rollover_contribution_amount: rollover_contribution_amount,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ContributionEntity | 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} security_id: #{@security_id}, security_id_type: #{@security_id_type},"\
+      " employer_match_percentage: #{@employer_match_percentage}, employer_match_amount:"\
+      " #{@employer_match_amount}, employee_pre_tax_amount: #{@employee_pre_tax_amount},"\
+      " employee_pre_tax_percentage: #{@employee_pre_tax_percentage}, employee_after_tax_amount:"\
+      " #{@employee_after_tax_amount}, employee_after_tax_percentage:"\
+      " #{@employee_after_tax_percentage}, employee_defer_pre_tax_amount:"\
+      " #{@employee_defer_pre_tax_amount}, employee_defer_pre_tax_percentage:"\
+      " #{@employee_defer_pre_tax_percentage}, employee_year_to_date: #{@employee_year_to_date},"\
+      " employer_year_to_date: #{@employer_year_to_date}, rollover_contribution_percentage:"\
+      " #{@rollover_contribution_percentage}, rollover_contribution_amount:"\
+      " #{@rollover_contribution_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} security_id: #{@security_id.inspect}, security_id_type:"\
+      " #{@security_id_type.inspect}, employer_match_percentage:"\
+      " #{@employer_match_percentage.inspect}, employer_match_amount:"\
+      " #{@employer_match_amount.inspect}, employee_pre_tax_amount:"\
+      " #{@employee_pre_tax_amount.inspect}, employee_pre_tax_percentage:"\
+      " #{@employee_pre_tax_percentage.inspect}, employee_after_tax_amount:"\
+      " #{@employee_after_tax_amount.inspect}, employee_after_tax_percentage:"\
+      " #{@employee_after_tax_percentage.inspect}, employee_defer_pre_tax_amount:"\
+      " #{@employee_defer_pre_tax_amount.inspect}, employee_defer_pre_tax_percentage:"\
+      " #{@employee_defer_pre_tax_percentage.inspect}, employee_year_to_date:"\
+      " #{@employee_year_to_date.inspect}, employer_year_to_date:"\
+      " #{@employer_year_to_date.inspect}, rollover_contribution_percentage:"\
+      " #{@rollover_contribution_percentage.inspect}, rollover_contribution_amount:"\
+      " #{@rollover_contribution_amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/coupon_mature_frequency.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The frequency of a bond's coupon maturity
+  class CouponMatureFrequency
+    COUPON_MATURE_FREQUENCY = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUAL
+      SEMIANNUAL = 'SEMIANNUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/coupon_mature_frequency2.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # When coupons mature. One of MONTHLY, QUARTERLY,  SEMIANNUAL, ANNUAL, OTHER
+  class CouponMatureFrequency2
+    COUPON_MATURE_FREQUENCY2 = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUAL
+      SEMIANNUAL = 'SEMIANNUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/coverage_month.rb

@@ -0,0 +1,56 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Month enumeration used on forms 1095-A and 1095-C
+  class CoverageMonth
+    COVERAGE_MONTH = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for JANUARY
+      JANUARY = 'JANUARY'.freeze,
+
+      # TODO: Write general description for FEBRUARY
+      FEBRUARY = 'FEBRUARY'.freeze,
+
+      # TODO: Write general description for MARCH
+      MARCH = 'MARCH'.freeze,
+
+      # TODO: Write general description for APRIL
+      APRIL = 'APRIL'.freeze,
+
+      # TODO: Write general description for MAY
+      MAY = 'MAY'.freeze,
+
+      # TODO: Write general description for JUNE
+      JUNE = 'JUNE'.freeze,
+
+      # TODO: Write general description for JULY
+      JULY = 'JULY'.freeze,
+
+      # TODO: Write general description for AUGUST
+      AUGUST = 'AUGUST'.freeze,
+
+      # TODO: Write general description for SEPTEMBER
+      SEPTEMBER = 'SEPTEMBER'.freeze,
+
+      # TODO: Write general description for OCTOBER
+      OCTOBER = 'OCTOBER'.freeze,
+
+      # TODO: Write general description for NOVEMBER
+      NOVEMBER = 'NOVEMBER'.freeze,
+
+      # TODO: Write general description for DECEMBER
+      DECEMBER = 'DECEMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/coverage_month1.rb

@@ -0,0 +1,56 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Month
+  class CoverageMonth1
+    COVERAGE_MONTH1 = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for JANUARY
+      JANUARY = 'JANUARY'.freeze,
+
+      # TODO: Write general description for FEBRUARY
+      FEBRUARY = 'FEBRUARY'.freeze,
+
+      # TODO: Write general description for MARCH
+      MARCH = 'MARCH'.freeze,
+
+      # TODO: Write general description for APRIL
+      APRIL = 'APRIL'.freeze,
+
+      # TODO: Write general description for MAY
+      MAY = 'MAY'.freeze,
+
+      # TODO: Write general description for JUNE
+      JUNE = 'JUNE'.freeze,
+
+      # TODO: Write general description for JULY
+      JULY = 'JULY'.freeze,
+
+      # TODO: Write general description for AUGUST
+      AUGUST = 'AUGUST'.freeze,
+
+      # TODO: Write general description for SEPTEMBER
+      SEPTEMBER = 'SEPTEMBER'.freeze,
+
+      # TODO: Write general description for OCTOBER
+      OCTOBER = 'OCTOBER'.freeze,
+
+      # TODO: Write general description for NOVEMBER
+      NOVEMBER = 'NOVEMBER'.freeze,
+
+      # TODO: Write general description for DECEMBER
+      DECEMBER = 'DECEMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/coverage_month3.rb

@@ -0,0 +1,56 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Month of coverage
+  class CoverageMonth3
+    COVERAGE_MONTH3 = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for JANUARY
+      JANUARY = 'JANUARY'.freeze,
+
+      # TODO: Write general description for FEBRUARY
+      FEBRUARY = 'FEBRUARY'.freeze,
+
+      # TODO: Write general description for MARCH
+      MARCH = 'MARCH'.freeze,
+
+      # TODO: Write general description for APRIL
+      APRIL = 'APRIL'.freeze,
+
+      # TODO: Write general description for MAY
+      MAY = 'MAY'.freeze,
+
+      # TODO: Write general description for JUNE
+      JUNE = 'JUNE'.freeze,
+
+      # TODO: Write general description for JULY
+      JULY = 'JULY'.freeze,
+
+      # TODO: Write general description for AUGUST
+      AUGUST = 'AUGUST'.freeze,
+
+      # TODO: Write general description for SEPTEMBER
+      SEPTEMBER = 'SEPTEMBER'.freeze,
+
+      # TODO: Write general description for OCTOBER
+      OCTOBER = 'OCTOBER'.freeze,
+
+      # TODO: Write general description for NOVEMBER
+      NOVEMBER = 'NOVEMBER'.freeze,
+
+      # TODO: Write general description for DECEMBER
+      DECEMBER = 'DECEMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end