hydrogen-proton-api 1.9.1

data/lib/proton_api/models/periods.rb

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

@@ -0,0 +1,356 @@
+=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 PortfolioOptimizationScoreRequest
+    attr_accessor :opt_config
+
+    attr_accessor :allocation_id
+
+    attr_accessor :end_date
+
+    attr_accessor :market_data_source
+
+    attr_accessor :model_id
+
+    attr_accessor :account_id
+
+    attr_accessor :start_date
+
+    attr_accessor :tgt_type
+
+    attr_accessor :use_proxy_data
+
+    attr_accessor :portfolio_weights
+
+    attr_accessor :portfolio_tickers
+
+    attr_accessor :create_log
+
+    attr_accessor :aggregation_account_id
+
+    attr_accessor :portfolio_id
+
+    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
+      {
+        :'opt_config' => :'opt_config',
+        :'allocation_id' => :'allocation_id',
+        :'end_date' => :'end_date',
+        :'market_data_source' => :'market_data_source',
+        :'model_id' => :'model_id',
+        :'account_id' => :'account_id',
+        :'start_date' => :'start_date',
+        :'tgt_type' => :'tgt_type',
+        :'use_proxy_data' => :'use_proxy_data',
+        :'portfolio_weights' => :'portfolio_weights',
+        :'portfolio_tickers' => :'portfolio_tickers',
+        :'create_log' => :'create_log',
+        :'aggregation_account_id' => :'aggregation_account_id',
+        :'portfolio_id' => :'portfolio_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'opt_config' => :'OptConfig1',
+        :'allocation_id' => :'String',
+        :'end_date' => :'Date',
+        :'market_data_source' => :'String',
+        :'model_id' => :'String',
+        :'account_id' => :'String',
+        :'start_date' => :'Date',
+        :'tgt_type' => :'String',
+        :'use_proxy_data' => :'BOOLEAN',
+        :'portfolio_weights' => :'Array<Float>',
+        :'portfolio_tickers' => :'Array<String>',
+        :'create_log' => :'BOOLEAN',
+        :'aggregation_account_id' => :'String',
+        :'portfolio_id' => :'String'
+      }
+    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?(:'opt_config')
+        self.opt_config = attributes[:'opt_config']
+      end
+
+      if attributes.has_key?(:'allocation_id')
+        self.allocation_id = attributes[:'allocation_id']
+      end
+
+      if attributes.has_key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      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?(:'model_id')
+        self.model_id = attributes[:'model_id']
+      end
+
+      if attributes.has_key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.has_key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.has_key?(:'tgt_type')
+        self.tgt_type = attributes[:'tgt_type']
+      else
+        self.tgt_type = 'return'
+      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?(:'portfolio_weights')
+        if (value = attributes[:'portfolio_weights']).is_a?(Array)
+          self.portfolio_weights = value
+        end
+      end
+
+      if attributes.has_key?(:'portfolio_tickers')
+        if (value = attributes[:'portfolio_tickers']).is_a?(Array)
+          self.portfolio_tickers = 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?(:'aggregation_account_id')
+        self.aggregation_account_id = attributes[:'aggregation_account_id']
+      end
+
+      if attributes.has_key?(:'portfolio_id')
+        self.portfolio_id = attributes[:'portfolio_id']
+      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
+      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?
+      market_data_source_validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
+      return false unless market_data_source_validator.valid?(@market_data_source)
+      tgt_type_validator = EnumAttributeValidator.new('String', ['risk', 'return'])
+      return false unless tgt_type_validator.valid?(@tgt_type)
+      true
+    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 checking allowed values (enum).
+    # @param [Object] tgt_type Object to be assigned
+    def tgt_type=(tgt_type)
+      validator = EnumAttributeValidator.new('String', ['risk', 'return'])
+      unless validator.valid?(tgt_type)
+        fail ArgumentError, 'invalid value for "tgt_type", must be one of #{validator.allowable_values}.'
+      end
+      @tgt_type = tgt_type
+    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 &&
+          opt_config == o.opt_config &&
+          allocation_id == o.allocation_id &&
+          end_date == o.end_date &&
+          market_data_source == o.market_data_source &&
+          model_id == o.model_id &&
+          account_id == o.account_id &&
+          start_date == o.start_date &&
+          tgt_type == o.tgt_type &&
+          use_proxy_data == o.use_proxy_data &&
+          portfolio_weights == o.portfolio_weights &&
+          portfolio_tickers == o.portfolio_tickers &&
+          create_log == o.create_log &&
+          aggregation_account_id == o.aggregation_account_id &&
+          portfolio_id == o.portfolio_id
+    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
+      [opt_config, allocation_id, end_date, market_data_source, model_id, account_id, start_date, tgt_type, use_proxy_data, portfolio_weights, portfolio_tickers, create_log, aggregation_account_id, portfolio_id].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