fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/state_tax_withholding2.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Amount of state income tax withheld
+  class StateTaxWithholding2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of state income tax withheld
+    # @return [Float]
+    attr_accessor :tax_withheld
+
+    # Filer's state tax id
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Income amount for state tax purposes
+    # @return [Float]
+    attr_accessor :income
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_withheld'] = 'taxWithheld'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['income'] = 'income'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_withheld
+        tax_id
+        income
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_withheld: SKIP, tax_id: SKIP, income: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_withheld = tax_withheld unless tax_withheld == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @income = income unless income == 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.
+      tax_withheld = hash.key?('taxWithheld') ? hash['taxWithheld'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      income = hash.key?('income') ? hash['income'] : 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.
+      StateTaxWithholding2.new(tax_withheld: tax_withheld,
+                               tax_id: tax_id,
+                               income: income,
+                               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} tax_withheld: #{@tax_withheld}, tax_id: #{@tax_id}, income: #{@income},"\
+      " 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} tax_withheld: #{@tax_withheld.inspect}, tax_id: #{@tax_id.inspect}, income:"\
+      " #{@income.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/statement_entity.rb

@@ -0,0 +1,135 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An account statement
+  class StatementEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Corresponds to accountId in Account entity
+    # @return [String]
+    attr_accessor :account_id
+
+    # Long-term persistent identity of the statement
+    # @return [String]
+    attr_accessor :statement_id
+
+    # Date of the statement
+    # @return [Date]
+    attr_accessor :statement_date
+
+    # Description of statement
+    # @return [String]
+    attr_accessor :description
+
+    # The links to retrieve this account statement, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Availability status of statement
+    # @return [DocumentStatus2]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['statement_id'] = 'statementId'
+      @_hash['statement_date'] = 'statementDate'
+      @_hash['description'] = 'description'
+      @_hash['links'] = 'links'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        statement_id
+        statement_date
+        description
+        links
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, statement_id: SKIP, statement_date: SKIP,
+                   description: SKIP, links: SKIP, status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @statement_id = statement_id unless statement_id == SKIP
+      @statement_date = statement_date unless statement_date == SKIP
+      @description = description unless description == SKIP
+      @links = links unless links == SKIP
+      @status = status unless status == 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.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      statement_id = hash.key?('statementId') ? hash['statementId'] : SKIP
+      statement_date = hash.key?('statementDate') ? hash['statementDate'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      status = hash.key?('status') ? hash['status'] : 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.
+      StatementEntity.new(account_id: account_id,
+                          statement_id: statement_id,
+                          statement_date: statement_date,
+                          description: description,
+                          links: links,
+                          status: status,
+                          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} account_id: #{@account_id}, statement_id: #{@statement_id}, statement_date:"\
+      " #{@statement_date}, description: #{@description}, links: #{@links}, status: #{@status},"\
+      " 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} account_id: #{@account_id.inspect}, statement_id: #{@statement_id.inspect},"\
+      " statement_date: #{@statement_date.inspect}, description: #{@description.inspect}, links:"\
+      " #{@links.inspect}, status: #{@status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/stock_security_entity.rb

@@ -0,0 +1,147 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxApi
+  # A stock security
+  class StockSecurityEntity < SecurityEntity
+    # The units in the FI's street name as a positive quantity
+    # @return [Float]
+    attr_accessor :units_street
+
+    # The units in user's name directly as a positive quantity
+    # @return [Float]
+    attr_accessor :units_user
+
+    # Selection to reinvest dividends
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reinvest_dividends
+
+    # COMMON, PREFERRED, CONVERTIBLE, OTHER
+    # @return [StockType2]
+    attr_accessor :stock_type
+
+    # The current yield
+    # @return [Float]
+    attr_accessor :myield
+
+    # Yield as-of date
+    # @return [Date]
+    attr_accessor :yield_as_of_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['units_street'] = 'unitsStreet'
+      @_hash['units_user'] = 'unitsUser'
+      @_hash['reinvest_dividends'] = 'reinvestDividends'
+      @_hash['stock_type'] = 'stockType'
+      @_hash['myield'] = 'yield'
+      @_hash['yield_as_of_date'] = 'yieldAsOfDate'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        units_street
+        units_user
+        reinvest_dividends
+        stock_type
+        myield
+        yield_as_of_date
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(units_street: SKIP, units_user: SKIP,
+                   reinvest_dividends: SKIP, stock_type: SKIP, myield: SKIP,
+                   yield_as_of_date: SKIP,
+                   security_category: 'Stock Security entity',
+                   additional_properties: nil)
+      @units_street = units_street unless units_street == SKIP
+      @units_user = units_user unless units_user == SKIP
+      @reinvest_dividends = reinvest_dividends unless reinvest_dividends == SKIP
+      @stock_type = stock_type unless stock_type == SKIP
+      @myield = myield unless myield == SKIP
+      @yield_as_of_date = yield_as_of_date unless yield_as_of_date == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(security_category: security_category,
+            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.
+      units_street = hash.key?('unitsStreet') ? hash['unitsStreet'] : SKIP
+      units_user = hash.key?('unitsUser') ? hash['unitsUser'] : SKIP
+      reinvest_dividends =
+        hash.key?('reinvestDividends') ? hash['reinvestDividends'] : SKIP
+      stock_type = hash.key?('stockType') ? hash['stockType'] : SKIP
+      myield = hash.key?('yield') ? hash['yield'] : SKIP
+      yield_as_of_date =
+        hash.key?('yieldAsOfDate') ? hash['yieldAsOfDate'] : SKIP
+      security_category = hash['securityCategory'] ||= 'Stock Security entity'
+
+      # 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.
+      StockSecurityEntity.new(units_street: units_street,
+                              units_user: units_user,
+                              reinvest_dividends: reinvest_dividends,
+                              stock_type: stock_type,
+                              myield: myield,
+                              yield_as_of_date: yield_as_of_date,
+                              security_category: security_category,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [StockSecurityEntity | 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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, units_street: #{@units_street}, units_user:"\
+      " #{@units_user}, reinvest_dividends: #{@reinvest_dividends}, stock_type: #{@stock_type},"\
+      " myield: #{@myield}, yield_as_of_date: #{@yield_as_of_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, units_street: #{@units_street.inspect}, units_user:"\
+      " #{@units_user.inspect}, reinvest_dividends: #{@reinvest_dividends.inspect}, stock_type:"\
+      " #{@stock_type.inspect}, myield: #{@myield.inspect}, yield_as_of_date:"\
+      " #{@yield_as_of_date.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/stock_type.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of a stock instrument
+  class StockType
+    STOCK_TYPE = [
+      # TODO: Write general description for COMMON
+      COMMON = 'COMMON'.freeze,
+
+      # TODO: Write general description for CONVERTIBLE
+      CONVERTIBLE = 'CONVERTIBLE'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for PREFERRED
+      PREFERRED = 'PREFERRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/stock_type2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # COMMON, PREFERRED, CONVERTIBLE, OTHER
+  class StockType2
+    STOCK_TYPE2 = [
+      # TODO: Write general description for COMMON
+      COMMON = 'COMMON'.freeze,
+
+      # TODO: Write general description for CONVERTIBLE
+      CONVERTIBLE = 'CONVERTIBLE'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for PREFERRED
+      PREFERRED = 'PREFERRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/sub_account_type.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The subtype of an account
+  class SubAccountType
+    SUB_ACCOUNT_TYPE = [
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for MARGIN
+      MARGIN = 'MARGIN'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SHORT
+      SHORT = 'SHORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/sub_account_type1.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Sub-account security Type. One of CASH, MARGIN, SHORT, OTHERS
+  class SubAccountType1
+    SUB_ACCOUNT_TYPE1 = [
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for MARGIN
+      MARGIN = 'MARGIN'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SHORT
+      SHORT = 'SHORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/sub_account_type2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # From which account money came in. One of CASH, MARGIN, SHORT, OTHERS
+  class SubAccountType2
+    SUB_ACCOUNT_TYPE2 = [
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for MARGIN
+      MARGIN = 'MARGIN'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SHORT
+      SHORT = 'SHORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/sub_account_type4.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # CASH, MARGIN, SHORT, OTHER
+  class SubAccountType4
+    SUB_ACCOUNT_TYPE4 = [
+      # TODO: Write general description for CASH
+      CASH = 'CASH'.freeze,
+
+      # TODO: Write general description for MARGIN
+      MARGIN = 'MARGIN'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SHORT
+      SHORT = 'SHORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/supplemental_status.rb

@@ -0,0 +1,44 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Additional information about ACTIVE/INACTIVE employment status
+  class SupplementalStatus
+    SUPPLEMENTAL_STATUS = [
+      # TODO: Write general description for FURLOUGHED
+      FURLOUGHED = 'FURLOUGHED'.freeze,
+
+      # TODO: Write general description for LEAVE
+      LEAVE = 'LEAVE'.freeze,
+
+      # TODO: Write general description for MEDICAL_LEAVE
+      MEDICAL_LEAVE = 'MEDICAL_LEAVE'.freeze,
+
+      # TODO: Write general description for MILITARY_LEAVE
+      MILITARY_LEAVE = 'MILITARY_LEAVE'.freeze,
+
+      # TODO: Write general description for PATERNITY_LEAVE
+      PATERNITY_LEAVE = 'PATERNITY_LEAVE'.freeze,
+
+      # TODO: Write general description for QUIT
+      QUIT = 'QUIT'.freeze,
+
+      # TODO: Write general description for RETIRED
+      RETIRED = 'RETIRED'.freeze,
+
+      # TODO: Write general description for TERMINATED
+      TERMINATED = 'TERMINATED'.freeze,
+
+      # TODO: Write general description for VACATION
+      VACATION = 'VACATION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/supplemental_status2.rb

@@ -0,0 +1,44 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Supplemental detail of employee's employment status
+  class SupplementalStatus2
+    SUPPLEMENTAL_STATUS2 = [
+      # TODO: Write general description for FURLOUGHED
+      FURLOUGHED = 'FURLOUGHED'.freeze,
+
+      # TODO: Write general description for LEAVE
+      LEAVE = 'LEAVE'.freeze,
+
+      # TODO: Write general description for MEDICAL_LEAVE
+      MEDICAL_LEAVE = 'MEDICAL_LEAVE'.freeze,
+
+      # TODO: Write general description for MILITARY_LEAVE
+      MILITARY_LEAVE = 'MILITARY_LEAVE'.freeze,
+
+      # TODO: Write general description for PATERNITY_LEAVE
+      PATERNITY_LEAVE = 'PATERNITY_LEAVE'.freeze,
+
+      # TODO: Write general description for QUIT
+      QUIT = 'QUIT'.freeze,
+
+      # TODO: Write general description for RETIRED
+      RETIRED = 'RETIRED'.freeze,
+
+      # TODO: Write general description for TERMINATED
+      TERMINATED = 'TERMINATED'.freeze,
+
+      # TODO: Write general description for VACATION
+      VACATION = 'VACATION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end