hydrogen-proton-api 1.9.1

data/lib/proton_api/models/annuity_calculator_decumulation_horizon_request.rb

@@ -0,0 +1,459 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.9.1
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'date'
+
+module ProtonApi
+  class AnnuityCalculatorDecumulationHorizonRequest
+    attr_accessor :inflation_rate
+
+    attr_accessor :decumulation_horizon
+
+    attr_accessor :account_ids
+
+    attr_accessor :tax_rate
+
+    attr_accessor :accumulation_horizon
+
+    attr_accessor :annuity_amount
+
+    attr_accessor :portfolio_return
+
+    attr_accessor :deposit_schedule
+
+    attr_accessor :annuity_frequency_interval
+
+    attr_accessor :initial_balance
+
+    attr_accessor :aggregation_account_ids
+
+    attr_accessor :create_log
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'inflation_rate' => :'inflation_rate',
+        :'decumulation_horizon' => :'decumulation_horizon',
+        :'account_ids' => :'account_ids',
+        :'tax_rate' => :'tax_rate',
+        :'accumulation_horizon' => :'accumulation_horizon',
+        :'annuity_amount' => :'annuity_amount',
+        :'portfolio_return' => :'portfolio_return',
+        :'deposit_schedule' => :'deposit_schedule',
+        :'annuity_frequency_interval' => :'annuity_frequency_interval',
+        :'initial_balance' => :'initial_balance',
+        :'aggregation_account_ids' => :'aggregation_account_ids',
+        :'create_log' => :'create_log'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'inflation_rate' => :'Float',
+        :'decumulation_horizon' => :'Integer',
+        :'account_ids' => :'Array<String>',
+        :'tax_rate' => :'Float',
+        :'accumulation_horizon' => :'Integer',
+        :'annuity_amount' => :'Float',
+        :'portfolio_return' => :'Float',
+        :'deposit_schedule' => :'AnnuityDepositSchedule',
+        :'annuity_frequency_interval' => :'String',
+        :'initial_balance' => :'Float',
+        :'aggregation_account_ids' => :'Array<String>',
+        :'create_log' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'inflation_rate')
+        self.inflation_rate = attributes[:'inflation_rate']
+      else
+        self.inflation_rate = 0.0
+      end
+
+      if attributes.has_key?(:'decumulation_horizon')
+        self.decumulation_horizon = attributes[:'decumulation_horizon']
+      end
+
+      if attributes.has_key?(:'account_ids')
+        if (value = attributes[:'account_ids']).is_a?(Array)
+          self.account_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'tax_rate')
+        self.tax_rate = attributes[:'tax_rate']
+      else
+        self.tax_rate = 0.0
+      end
+
+      if attributes.has_key?(:'accumulation_horizon')
+        self.accumulation_horizon = attributes[:'accumulation_horizon']
+      end
+
+      if attributes.has_key?(:'annuity_amount')
+        self.annuity_amount = attributes[:'annuity_amount']
+      end
+
+      if attributes.has_key?(:'portfolio_return')
+        self.portfolio_return = attributes[:'portfolio_return']
+      end
+
+      if attributes.has_key?(:'deposit_schedule')
+        self.deposit_schedule = attributes[:'deposit_schedule']
+      end
+
+      if attributes.has_key?(:'annuity_frequency_interval')
+        self.annuity_frequency_interval = attributes[:'annuity_frequency_interval']
+      else
+        self.annuity_frequency_interval = 'year'
+      end
+
+      if attributes.has_key?(:'initial_balance')
+        self.initial_balance = attributes[:'initial_balance']
+      else
+        self.initial_balance = 0.0
+      end
+
+      if attributes.has_key?(:'aggregation_account_ids')
+        if (value = attributes[:'aggregation_account_ids']).is_a?(Array)
+          self.aggregation_account_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'create_log')
+        self.create_log = attributes[:'create_log']
+      else
+        self.create_log = false
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@inflation_rate.nil? && @inflation_rate > 20
+        invalid_properties.push('invalid value for "inflation_rate", must be smaller than or equal to 20.')
+      end
+
+      if !@inflation_rate.nil? && @inflation_rate < -1
+        invalid_properties.push('invalid value for "inflation_rate", must be greater than or equal to -1.')
+      end
+
+      if !@decumulation_horizon.nil? && @decumulation_horizon < 1
+        invalid_properties.push('invalid value for "decumulation_horizon", must be greater than or equal to 1.')
+      end
+
+      if !@tax_rate.nil? && @tax_rate > 1
+        invalid_properties.push('invalid value for "tax_rate", must be smaller than or equal to 1.')
+      end
+
+      if !@tax_rate.nil? && @tax_rate < 0
+        invalid_properties.push('invalid value for "tax_rate", must be greater than or equal to 0.')
+      end
+
+      if @accumulation_horizon.nil?
+        invalid_properties.push('invalid value for "accumulation_horizon", accumulation_horizon cannot be nil.')
+      end
+
+      if @accumulation_horizon < 0
+        invalid_properties.push('invalid value for "accumulation_horizon", must be greater than or equal to 0.')
+      end
+
+      if @annuity_amount.nil?
+        invalid_properties.push('invalid value for "annuity_amount", annuity_amount cannot be nil.')
+      end
+
+      if @annuity_amount < 0
+        invalid_properties.push('invalid value for "annuity_amount", must be greater than or equal to 0.')
+      end
+
+      if @portfolio_return.nil?
+        invalid_properties.push('invalid value for "portfolio_return", portfolio_return cannot be nil.')
+      end
+
+      if !@initial_balance.nil? && @initial_balance < 0
+        invalid_properties.push('invalid value for "initial_balance", must be greater than or equal to 0.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@inflation_rate.nil? && @inflation_rate > 20
+      return false if !@inflation_rate.nil? && @inflation_rate < -1
+      return false if !@decumulation_horizon.nil? && @decumulation_horizon < 1
+      return false if !@tax_rate.nil? && @tax_rate > 1
+      return false if !@tax_rate.nil? && @tax_rate < 0
+      return false if @accumulation_horizon.nil?
+      return false if @accumulation_horizon < 0
+      return false if @annuity_amount.nil?
+      return false if @annuity_amount < 0
+      return false if @portfolio_return.nil?
+      annuity_frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
+      return false unless annuity_frequency_interval_validator.valid?(@annuity_frequency_interval)
+      return false if !@initial_balance.nil? && @initial_balance < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] inflation_rate Value to be assigned
+    def inflation_rate=(inflation_rate)
+      if !inflation_rate.nil? && inflation_rate > 20
+        fail ArgumentError, 'invalid value for "inflation_rate", must be smaller than or equal to 20.'
+      end
+
+      if !inflation_rate.nil? && inflation_rate < -1
+        fail ArgumentError, 'invalid value for "inflation_rate", must be greater than or equal to -1.'
+      end
+
+      @inflation_rate = inflation_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] decumulation_horizon Value to be assigned
+    def decumulation_horizon=(decumulation_horizon)
+      if !decumulation_horizon.nil? && decumulation_horizon < 1
+        fail ArgumentError, 'invalid value for "decumulation_horizon", must be greater than or equal to 1.'
+      end
+
+      @decumulation_horizon = decumulation_horizon
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_rate Value to be assigned
+    def tax_rate=(tax_rate)
+      if !tax_rate.nil? && tax_rate > 1
+        fail ArgumentError, 'invalid value for "tax_rate", must be smaller than or equal to 1.'
+      end
+
+      if !tax_rate.nil? && tax_rate < 0
+        fail ArgumentError, 'invalid value for "tax_rate", must be greater than or equal to 0.'
+      end
+
+      @tax_rate = tax_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] accumulation_horizon Value to be assigned
+    def accumulation_horizon=(accumulation_horizon)
+      if accumulation_horizon.nil?
+        fail ArgumentError, 'accumulation_horizon cannot be nil'
+      end
+
+      if accumulation_horizon < 0
+        fail ArgumentError, 'invalid value for "accumulation_horizon", must be greater than or equal to 0.'
+      end
+
+      @accumulation_horizon = accumulation_horizon
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] annuity_amount Value to be assigned
+    def annuity_amount=(annuity_amount)
+      if annuity_amount.nil?
+        fail ArgumentError, 'annuity_amount cannot be nil'
+      end
+
+      if annuity_amount < 0
+        fail ArgumentError, 'invalid value for "annuity_amount", must be greater than or equal to 0.'
+      end
+
+      @annuity_amount = annuity_amount
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] annuity_frequency_interval Object to be assigned
+    def annuity_frequency_interval=(annuity_frequency_interval)
+      validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
+      unless validator.valid?(annuity_frequency_interval)
+        fail ArgumentError, 'invalid value for "annuity_frequency_interval", must be one of #{validator.allowable_values}.'
+      end
+      @annuity_frequency_interval = annuity_frequency_interval
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] initial_balance Value to be assigned
+    def initial_balance=(initial_balance)
+      if !initial_balance.nil? && initial_balance < 0
+        fail ArgumentError, 'invalid value for "initial_balance", must be greater than or equal to 0.'
+      end
+
+      @initial_balance = initial_balance
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          inflation_rate == o.inflation_rate &&
+          decumulation_horizon == o.decumulation_horizon &&
+          account_ids == o.account_ids &&
+          tax_rate == o.tax_rate &&
+          accumulation_horizon == o.accumulation_horizon &&
+          annuity_amount == o.annuity_amount &&
+          portfolio_return == o.portfolio_return &&
+          deposit_schedule == o.deposit_schedule &&
+          annuity_frequency_interval == o.annuity_frequency_interval &&
+          initial_balance == o.initial_balance &&
+          aggregation_account_ids == o.aggregation_account_ids &&
+          create_log == o.create_log
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [inflation_rate, decumulation_horizon, account_ids, tax_rate, accumulation_horizon, annuity_amount, portfolio_return, deposit_schedule, annuity_frequency_interval, initial_balance, aggregation_account_ids, create_log].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+# Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        value
+      when :Date
+        value
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = ProtonApi.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+# Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+# Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end