proton_api 1.8.0

data/lib/proton_api/models/monte_carlo_request.rb

@@ -0,0 +1,507 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'date'
+
+module ProtonApi
+  class MonteCarloRequest
+    attr_accessor :portfolio_id
+
+    attr_accessor :max_sample
+
+    attr_accessor :result_type
+
+    attr_accessor :ret_mod
+
+    attr_accessor :remove_outliers
+
+    attr_accessor :max_bal
+
+    attr_accessor :market_data_source
+
+    attr_accessor :p
+
+    attr_accessor :allocation_id
+
+    attr_accessor :use_proxy_data
+
+    attr_accessor :aggregation_account_id
+
+    attr_accessor :init_bal
+
+    attr_accessor :min_sample
+
+    attr_accessor :create_log
+
+    attr_accessor :mu
+
+    attr_accessor :account_id
+
+    attr_accessor :sigma
+
+    attr_accessor :model_id
+
+    attr_accessor :n
+
+    attr_accessor :min_bal
+
+    attr_accessor :frequency_interval
+
+    attr_accessor :cf
+
+    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
+      {
+        :'portfolio_id' => :'portfolio_id',
+        :'max_sample' => :'max_sample',
+        :'result_type' => :'result_type',
+        :'ret_mod' => :'ret_mod',
+        :'remove_outliers' => :'remove_outliers',
+        :'max_bal' => :'max_bal',
+        :'market_data_source' => :'market_data_source',
+        :'p' => :'p',
+        :'allocation_id' => :'allocation_id',
+        :'use_proxy_data' => :'use_proxy_data',
+        :'aggregation_account_id' => :'aggregation_account_id',
+        :'init_bal' => :'init_bal',
+        :'min_sample' => :'min_sample',
+        :'create_log' => :'create_log',
+        :'mu' => :'mu',
+        :'account_id' => :'account_id',
+        :'sigma' => :'sigma',
+        :'model_id' => :'model_id',
+        :'n' => :'n',
+        :'min_bal' => :'min_bal',
+        :'frequency_interval' => :'frequency_interval',
+        :'cf' => :'cf'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'portfolio_id' => :'String',
+        :'max_sample' => :'Array<Float>',
+        :'result_type' => :'String',
+        :'ret_mod' => :'Array<Float>',
+        :'remove_outliers' => :'BOOLEAN',
+        :'max_bal' => :'Array<Float>',
+        :'market_data_source' => :'String',
+        :'p' => :'Array<Float>',
+        :'allocation_id' => :'String',
+        :'use_proxy_data' => :'BOOLEAN',
+        :'aggregation_account_id' => :'String',
+        :'init_bal' => :'Float',
+        :'min_sample' => :'Array<Float>',
+        :'create_log' => :'BOOLEAN',
+        :'mu' => :'Array<Float>',
+        :'account_id' => :'String',
+        :'sigma' => :'Array<Float>',
+        :'model_id' => :'String',
+        :'n' => :'Integer',
+        :'min_bal' => :'Array<Float>',
+        :'frequency_interval' => :'String',
+        :'cf' => :'Array<Array<Float>>'
+      }
+    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?(:'portfolio_id')
+        self.portfolio_id = attributes[:'portfolio_id']
+      end
+
+      if attributes.has_key?(:'max_sample')
+        if (value = attributes[:'max_sample']).is_a?(Array)
+          self.max_sample = value
+        end
+      end
+
+      if attributes.has_key?(:'result_type')
+        self.result_type = attributes[:'result_type']
+      else
+        self.result_type = 'raw'
+      end
+
+      if attributes.has_key?(:'ret_mod')
+        if (value = attributes[:'ret_mod']).is_a?(Array)
+          self.ret_mod = value
+        end
+      end
+
+      if attributes.has_key?(:'remove_outliers')
+        self.remove_outliers = attributes[:'remove_outliers']
+      else
+        self.remove_outliers = false
+      end
+
+      if attributes.has_key?(:'max_bal')
+        if (value = attributes[:'max_bal']).is_a?(Array)
+          self.max_bal = value
+        end
+      end
+
+      if attributes.has_key?(:'market_data_source')
+        self.market_data_source = attributes[:'market_data_source']
+      else
+        self.market_data_source = 'nucleus'
+      end
+
+      if attributes.has_key?(:'p')
+        if (value = attributes[:'p']).is_a?(Array)
+          self.p = value
+        end
+      end
+
+      if attributes.has_key?(:'allocation_id')
+        self.allocation_id = attributes[:'allocation_id']
+      end
+
+      if attributes.has_key?(:'use_proxy_data')
+        self.use_proxy_data = attributes[:'use_proxy_data']
+      else
+        self.use_proxy_data = false
+      end
+
+      if attributes.has_key?(:'aggregation_account_id')
+        self.aggregation_account_id = attributes[:'aggregation_account_id']
+      end
+
+      if attributes.has_key?(:'init_bal')
+        self.init_bal = attributes[:'init_bal']
+      end
+
+      if attributes.has_key?(:'min_sample')
+        if (value = attributes[:'min_sample']).is_a?(Array)
+          self.min_sample = value
+        end
+      end
+
+      if attributes.has_key?(:'create_log')
+        self.create_log = attributes[:'create_log']
+      else
+        self.create_log = false
+      end
+
+      if attributes.has_key?(:'mu')
+        if (value = attributes[:'mu']).is_a?(Array)
+          self.mu = value
+        end
+      end
+
+      if attributes.has_key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.has_key?(:'sigma')
+        if (value = attributes[:'sigma']).is_a?(Array)
+          self.sigma = value
+        end
+      end
+
+      if attributes.has_key?(:'model_id')
+        self.model_id = attributes[:'model_id']
+      end
+
+      if attributes.has_key?(:'n')
+        self.n = attributes[:'n']
+      else
+        self.n = 1000
+      end
+
+      if attributes.has_key?(:'min_bal')
+        if (value = attributes[:'min_bal']).is_a?(Array)
+          self.min_bal = value
+        end
+      end
+
+      if attributes.has_key?(:'frequency_interval')
+        self.frequency_interval = attributes[:'frequency_interval']
+      else
+        self.frequency_interval = 'year'
+      end
+
+      if attributes.has_key?(:'cf')
+        if (value = attributes[:'cf']).is_a?(Array)
+          self.cf = value
+        end
+      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 !@init_bal.nil? && @init_bal < 0
+        invalid_properties.push('invalid value for "init_bal", must be greater than or equal to 0.')
+      end
+
+      if !@n.nil? && @n > 10000
+        invalid_properties.push('invalid value for "n", must be smaller than or equal to 10000.')
+      end
+
+      if !@n.nil? && @n < 1
+        invalid_properties.push('invalid value for "n", must be greater than or equal to 1.')
+      end
+
+      if @cf.nil?
+        invalid_properties.push('invalid value for "cf", cf cannot be nil.')
+      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?
+      result_type_validator = EnumAttributeValidator.new('String', ['raw', 'custom', 'median', 'mean', 'tens'])
+      return false unless result_type_validator.valid?(@result_type)
+      market_data_source_validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
+      return false unless market_data_source_validator.valid?(@market_data_source)
+      return false if !@init_bal.nil? && @init_bal < 0
+      return false if !@n.nil? && @n > 10000
+      return false if !@n.nil? && @n < 1
+      frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day'])
+      return false unless frequency_interval_validator.valid?(@frequency_interval)
+      return false if @cf.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] result_type Object to be assigned
+    def result_type=(result_type)
+      validator = EnumAttributeValidator.new('String', ['raw', 'custom', 'median', 'mean', 'tens'])
+      unless validator.valid?(result_type)
+        fail ArgumentError, 'invalid value for "result_type", must be one of #{validator.allowable_values}.'
+      end
+      @result_type = result_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] market_data_source Object to be assigned
+    def market_data_source=(market_data_source)
+      validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
+      unless validator.valid?(market_data_source)
+        fail ArgumentError, 'invalid value for "market_data_source", must be one of #{validator.allowable_values}.'
+      end
+      @market_data_source = market_data_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] init_bal Value to be assigned
+    def init_bal=(init_bal)
+      if !init_bal.nil? && init_bal < 0
+        fail ArgumentError, 'invalid value for "init_bal", must be greater than or equal to 0.'
+      end
+
+      @init_bal = init_bal
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] n Value to be assigned
+    def n=(n)
+      if !n.nil? && n > 10000
+        fail ArgumentError, 'invalid value for "n", must be smaller than or equal to 10000.'
+      end
+
+      if !n.nil? && n < 1
+        fail ArgumentError, 'invalid value for "n", must be greater than or equal to 1.'
+      end
+
+      @n = n
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] frequency_interval Object to be assigned
+    def frequency_interval=(frequency_interval)
+      validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day'])
+      unless validator.valid?(frequency_interval)
+        fail ArgumentError, 'invalid value for "frequency_interval", must be one of #{validator.allowable_values}.'
+      end
+      @frequency_interval = frequency_interval
+    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 &&
+          portfolio_id == o.portfolio_id &&
+          max_sample == o.max_sample &&
+          result_type == o.result_type &&
+          ret_mod == o.ret_mod &&
+          remove_outliers == o.remove_outliers &&
+          max_bal == o.max_bal &&
+          market_data_source == o.market_data_source &&
+          p == o.p &&
+          allocation_id == o.allocation_id &&
+          use_proxy_data == o.use_proxy_data &&
+          aggregation_account_id == o.aggregation_account_id &&
+          init_bal == o.init_bal &&
+          min_sample == o.min_sample &&
+          create_log == o.create_log &&
+          mu == o.mu &&
+          account_id == o.account_id &&
+          sigma == o.sigma &&
+          model_id == o.model_id &&
+          n == o.n &&
+          min_bal == o.min_bal &&
+          frequency_interval == o.frequency_interval &&
+          cf == o.cf
+    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
+      [portfolio_id, max_sample, result_type, ret_mod, remove_outliers, max_bal, market_data_source, p, allocation_id, use_proxy_data, aggregation_account_id, init_bal, min_sample, create_log, mu, account_id, sigma, model_id, n, min_bal, frequency_interval, cf].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
+        DateTime.parse(value)
+      when :Date
+        Date.parse(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