fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/monetary_amount3.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Bonus pay for covered period
+  class MonetaryAmount3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == 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'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      MonetaryAmount3.new(amount: amount,
+                          currency: currency,
+                          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} amount: #{@amount}, currency: #{@currency}, 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}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/monetary_amount4.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Commission for covered period
+  class MonetaryAmount4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == 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'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      MonetaryAmount4.new(amount: amount,
+                          currency: currency,
+                          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} amount: #{@amount}, currency: #{@currency}, 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}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/monetary_amount5.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Overtime pay for covered period
+  class MonetaryAmount5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == 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'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      MonetaryAmount5.new(amount: amount,
+                          currency: currency,
+                          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} amount: #{@amount}, currency: #{@currency}, 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}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/monetary_amount6.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Net pay for covered period
+  class MonetaryAmount6 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == 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'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      MonetaryAmount6.new(amount: amount,
+                          currency: currency,
+                          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} amount: #{@amount}, currency: #{@currency}, 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}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/month_abbreviation.rb

@@ -0,0 +1,53 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Used by MonthAmount
+  class MonthAbbreviation
+    MONTH_ABBREVIATION = [
+      # TODO: Write general description for JAN
+      JAN = 'JAN'.freeze,
+
+      # TODO: Write general description for FEB
+      FEB = 'FEB'.freeze,
+
+      # TODO: Write general description for MAR
+      MAR = 'MAR'.freeze,
+
+      # TODO: Write general description for APR
+      APR = 'APR'.freeze,
+
+      # TODO: Write general description for MAY
+      MAY = 'MAY'.freeze,
+
+      # TODO: Write general description for JUN
+      JUN = 'JUN'.freeze,
+
+      # TODO: Write general description for JUL
+      JUL = 'JUL'.freeze,
+
+      # TODO: Write general description for AUG
+      AUG = 'AUG'.freeze,
+
+      # TODO: Write general description for SEP
+      SEP = 'SEP'.freeze,
+
+      # TODO: Write general description for OCT
+      OCT = 'OCT'.freeze,
+
+      # TODO: Write general description for NOV
+      NOV = 'NOV'.freeze,
+
+      # TODO: Write general description for DEC
+      DEC = 'DEC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/month_abbreviation1.rb

@@ -0,0 +1,53 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Month
+  class MonthAbbreviation1
+    MONTH_ABBREVIATION1 = [
+      # TODO: Write general description for JAN
+      JAN = 'JAN'.freeze,
+
+      # TODO: Write general description for FEB
+      FEB = 'FEB'.freeze,
+
+      # TODO: Write general description for MAR
+      MAR = 'MAR'.freeze,
+
+      # TODO: Write general description for APR
+      APR = 'APR'.freeze,
+
+      # TODO: Write general description for MAY
+      MAY = 'MAY'.freeze,
+
+      # TODO: Write general description for JUN
+      JUN = 'JUN'.freeze,
+
+      # TODO: Write general description for JUL
+      JUL = 'JUL'.freeze,
+
+      # TODO: Write general description for AUG
+      AUG = 'AUG'.freeze,
+
+      # TODO: Write general description for SEP
+      SEP = 'SEP'.freeze,
+
+      # TODO: Write general description for OCT
+      OCT = 'OCT'.freeze,
+
+      # TODO: Write general description for NOV
+      NOV = 'NOV'.freeze,
+
+      # TODO: Write general description for DEC
+      DEC = 'DEC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/month_and_amount.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Month and amount pair used on IRS Form 1099-K, etc.
+  class MonthAndAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Month
+    # @return [MonthAbbreviation1]
+    attr_accessor :month
+
+    # Amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['month'] = 'month'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        month
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(month: SKIP, amount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @month = month unless month == SKIP
+      @amount = amount unless 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.
+      month = hash.key?('month') ? hash['month'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : 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.
+      MonthAndAmount.new(month: month,
+                         amount: amount,
+                         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} month: #{@month}, amount: #{@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} month: #{@month.inspect}, amount: #{@amount.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/mutual_fund_security_entity.rb

@@ -0,0 +1,161 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxApi
+  # A mutual fund
+  class MutualFundSecurityEntity < SecurityEntity
+    # Mutual fund type. One of OPENEND, CLOSEEND, OTHER
+    # @return [MutualFundType2]
+    attr_accessor :mutual_fund_type
+
+    # Units in the FI's street name, positive quantity
+    # @return [Float]
+    attr_accessor :units_street
+
+    # Units in user's name directly, positive  quantity
+    # @return [Float]
+    attr_accessor :units_user
+
+    # Reinvest dividends
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reinvest_dividends
+
+    # Reinvest capital gains
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reinvest_capital_gains
+
+    # Current yield reported as portion of the fund's assets
+    # @return [Float]
+    attr_accessor :myield
+
+    # As-of date for yield value
+    # @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['mutual_fund_type'] = 'mutualFundType'
+      @_hash['units_street'] = 'unitsStreet'
+      @_hash['units_user'] = 'unitsUser'
+      @_hash['reinvest_dividends'] = 'reinvestDividends'
+      @_hash['reinvest_capital_gains'] = 'reinvestCapitalGains'
+      @_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[
+        mutual_fund_type
+        units_street
+        units_user
+        reinvest_dividends
+        reinvest_capital_gains
+        myield
+        yield_as_of_date
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(mutual_fund_type: SKIP, units_street: SKIP, units_user: SKIP,
+                   reinvest_dividends: SKIP, reinvest_capital_gains: SKIP,
+                   myield: SKIP, yield_as_of_date: SKIP,
+                   security_category: 'Mutual Fund Security entity',
+                   additional_properties: nil)
+      @mutual_fund_type = mutual_fund_type unless mutual_fund_type == SKIP
+      @units_street = units_street unless units_street == SKIP
+      @units_user = units_user unless units_user == SKIP
+      @reinvest_dividends = reinvest_dividends unless reinvest_dividends == SKIP
+      @reinvest_capital_gains = reinvest_capital_gains unless reinvest_capital_gains == 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.
+      mutual_fund_type =
+        hash.key?('mutualFundType') ? hash['mutualFundType'] : SKIP
+      units_street = hash.key?('unitsStreet') ? hash['unitsStreet'] : SKIP
+      units_user = hash.key?('unitsUser') ? hash['unitsUser'] : SKIP
+      reinvest_dividends =
+        hash.key?('reinvestDividends') ? hash['reinvestDividends'] : SKIP
+      reinvest_capital_gains =
+        hash.key?('reinvestCapitalGains') ? hash['reinvestCapitalGains'] : SKIP
+      myield = hash.key?('yield') ? hash['yield'] : SKIP
+      yield_as_of_date =
+        hash.key?('yieldAsOfDate') ? hash['yieldAsOfDate'] : SKIP
+      security_category =
+        hash['securityCategory'] ||= 'Mutual Fund 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.
+      MutualFundSecurityEntity.new(mutual_fund_type: mutual_fund_type,
+                                   units_street: units_street,
+                                   units_user: units_user,
+                                   reinvest_dividends: reinvest_dividends,
+                                   reinvest_capital_gains: reinvest_capital_gains,
+                                   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 [MutualFundSecurityEntity | 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}, mutual_fund_type: #{@mutual_fund_type}, units_street:"\
+      " #{@units_street}, units_user: #{@units_user}, reinvest_dividends: #{@reinvest_dividends},"\
+      " reinvest_capital_gains: #{@reinvest_capital_gains}, 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}, mutual_fund_type: #{@mutual_fund_type.inspect},"\
+      " units_street: #{@units_street.inspect}, units_user: #{@units_user.inspect},"\
+      " reinvest_dividends: #{@reinvest_dividends.inspect}, reinvest_capital_gains:"\
+      " #{@reinvest_capital_gains.inspect}, myield: #{@myield.inspect}, yield_as_of_date:"\
+      " #{@yield_as_of_date.inspect}>"
+    end
+  end
+end