hydrogen-proton-api 1.9.1

data/lib/proton_api/models/goal_withdrawal_config.rb

@@ -0,0 +1,335 @@
+=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 GoalWithdrawalConfig
+    attr_accessor :with_inflation
+
+    attr_accessor :with_frequency
+
+    attr_accessor :with_end_reference
+
+    attr_accessor :with_start_reference
+
+    attr_accessor :with_end_period
+
+    attr_accessor :with_amount
+
+    attr_accessor :with_start_period
+
+    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
+      {
+        :'with_inflation' => :'with_inflation',
+        :'with_frequency' => :'with_frequency',
+        :'with_end_reference' => :'with_end_reference',
+        :'with_start_reference' => :'with_start_reference',
+        :'with_end_period' => :'with_end_period',
+        :'with_amount' => :'with_amount',
+        :'with_start_period' => :'with_start_period'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'with_inflation' => :'Float',
+        :'with_frequency' => :'String',
+        :'with_end_reference' => :'String',
+        :'with_start_reference' => :'String',
+        :'with_end_period' => :'Integer',
+        :'with_amount' => :'Float',
+        :'with_start_period' => :'Integer'
+      }
+    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?(:'with_inflation')
+        self.with_inflation = attributes[:'with_inflation']
+      else
+        self.with_inflation = 0.0
+      end
+
+      if attributes.has_key?(:'with_frequency')
+        self.with_frequency = attributes[:'with_frequency']
+      else
+        self.with_frequency = 'year'
+      end
+
+      if attributes.has_key?(:'with_end_reference')
+        self.with_end_reference = attributes[:'with_end_reference']
+      else
+        self.with_end_reference = 'd_end'
+      end
+
+      if attributes.has_key?(:'with_start_reference')
+        self.with_start_reference = attributes[:'with_start_reference']
+      else
+        self.with_start_reference = 'a_end'
+      end
+
+      if attributes.has_key?(:'with_end_period')
+        self.with_end_period = attributes[:'with_end_period']
+      else
+        self.with_end_period = 0
+      end
+
+      if attributes.has_key?(:'with_amount')
+        self.with_amount = attributes[:'with_amount']
+      end
+
+      if attributes.has_key?(:'with_start_period')
+        self.with_start_period = attributes[:'with_start_period']
+      else
+        self.with_start_period = 0
+      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 !@with_inflation.nil? && @with_inflation < -1
+        invalid_properties.push('invalid value for "with_inflation", must be greater than or equal to -1.')
+      end
+
+      if !@with_amount.nil? && @with_amount < 0
+        invalid_properties.push('invalid value for "with_amount", 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 !@with_inflation.nil? && @with_inflation < -1
+      with_frequency_validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day'])
+      return false unless with_frequency_validator.valid?(@with_frequency)
+      with_end_reference_validator = EnumAttributeValidator.new('String', ['a_end', 'd_end'])
+      return false unless with_end_reference_validator.valid?(@with_end_reference)
+      with_start_reference_validator = EnumAttributeValidator.new('String', ['a_end', 'd_end'])
+      return false unless with_start_reference_validator.valid?(@with_start_reference)
+      return false if !@with_amount.nil? && @with_amount < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] with_inflation Value to be assigned
+    def with_inflation=(with_inflation)
+      if !with_inflation.nil? && with_inflation < -1
+        fail ArgumentError, 'invalid value for "with_inflation", must be greater than or equal to -1.'
+      end
+
+      @with_inflation = with_inflation
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] with_frequency Object to be assigned
+    def with_frequency=(with_frequency)
+      validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day'])
+      unless validator.valid?(with_frequency)
+        fail ArgumentError, 'invalid value for "with_frequency", must be one of #{validator.allowable_values}.'
+      end
+      @with_frequency = with_frequency
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] with_end_reference Object to be assigned
+    def with_end_reference=(with_end_reference)
+      validator = EnumAttributeValidator.new('String', ['a_end', 'd_end'])
+      unless validator.valid?(with_end_reference)
+        fail ArgumentError, 'invalid value for "with_end_reference", must be one of #{validator.allowable_values}.'
+      end
+      @with_end_reference = with_end_reference
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] with_start_reference Object to be assigned
+    def with_start_reference=(with_start_reference)
+      validator = EnumAttributeValidator.new('String', ['a_end', 'd_end'])
+      unless validator.valid?(with_start_reference)
+        fail ArgumentError, 'invalid value for "with_start_reference", must be one of #{validator.allowable_values}.'
+      end
+      @with_start_reference = with_start_reference
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] with_amount Value to be assigned
+    def with_amount=(with_amount)
+      if !with_amount.nil? && with_amount < 0
+        fail ArgumentError, 'invalid value for "with_amount", must be greater than or equal to 0.'
+      end
+
+      @with_amount = with_amount
+    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 &&
+          with_inflation == o.with_inflation &&
+          with_frequency == o.with_frequency &&
+          with_end_reference == o.with_end_reference &&
+          with_start_reference == o.with_start_reference &&
+          with_end_period == o.with_end_period &&
+          with_amount == o.with_amount &&
+          with_start_period == o.with_start_period
+    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
+      [with_inflation, with_frequency, with_end_reference, with_start_reference, with_end_period, with_amount, with_start_period].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

data/lib/proton_api/models/guaranteed_rate_benefit.rb

@@ -0,0 +1,272 @@
+=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 GuaranteedRateBenefit
+    attr_accessor :max_rate
+
+    attr_accessor :end_period
+
+    attr_accessor :min_rate
+
+    attr_accessor :start_period
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'max_rate' => :'max_rate',
+        :'end_period' => :'end_period',
+        :'min_rate' => :'min_rate',
+        :'start_period' => :'start_period'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'max_rate' => :'Float',
+        :'end_period' => :'Integer',
+        :'min_rate' => :'Float',
+        :'start_period' => :'Integer'
+      }
+    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?(:'max_rate')
+        self.max_rate = attributes[:'max_rate']
+      end
+
+      if attributes.has_key?(:'end_period')
+        self.end_period = attributes[:'end_period']
+      end
+
+      if attributes.has_key?(:'min_rate')
+        self.min_rate = attributes[:'min_rate']
+      else
+        self.min_rate = 0.0
+      end
+
+      if attributes.has_key?(:'start_period')
+        self.start_period = attributes[:'start_period']
+      else
+        self.start_period = 1
+      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 !@max_rate.nil? && @max_rate < -1
+        invalid_properties.push('invalid value for "max_rate", must be greater than or equal to -1.')
+      end
+
+      if !@end_period.nil? && @end_period < 1
+        invalid_properties.push('invalid value for "end_period", must be greater than or equal to 1.')
+      end
+
+      if !@min_rate.nil? && @min_rate < -1
+        invalid_properties.push('invalid value for "min_rate", must be greater than or equal to -1.')
+      end
+
+      if !@start_period.nil? && @start_period < 1
+        invalid_properties.push('invalid value for "start_period", must be greater than or equal to 1.')
+      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 !@max_rate.nil? && @max_rate < -1
+      return false if !@end_period.nil? && @end_period < 1
+      return false if !@min_rate.nil? && @min_rate < -1
+      return false if !@start_period.nil? && @start_period < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_rate Value to be assigned
+    def max_rate=(max_rate)
+      if !max_rate.nil? && max_rate < -1
+        fail ArgumentError, 'invalid value for "max_rate", must be greater than or equal to -1.'
+      end
+
+      @max_rate = max_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] end_period Value to be assigned
+    def end_period=(end_period)
+      if !end_period.nil? && end_period < 1
+        fail ArgumentError, 'invalid value for "end_period", must be greater than or equal to 1.'
+      end
+
+      @end_period = end_period
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_rate Value to be assigned
+    def min_rate=(min_rate)
+      if !min_rate.nil? && min_rate < -1
+        fail ArgumentError, 'invalid value for "min_rate", must be greater than or equal to -1.'
+      end
+
+      @min_rate = min_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_period Value to be assigned
+    def start_period=(start_period)
+      if !start_period.nil? && start_period < 1
+        fail ArgumentError, 'invalid value for "start_period", must be greater than or equal to 1.'
+      end
+
+      @start_period = start_period
+    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 &&
+          max_rate == o.max_rate &&
+          end_period == o.end_period &&
+          min_rate == o.min_rate &&
+          start_period == o.start_period
+    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
+      [max_rate, end_period, min_rate, start_period].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