class ProtonApi::SensitivityAnalysisRequest

Attributes

account_id[RW]
aggregation_account_id[RW]
allocation_id[RW]
create_log[RW]
end_date[RW]
frequency_interval[RW]
market_data_source[RW]
model_id[RW]
portfolio_id[RW]
portfolio_tickers[RW]
portfolio_weights[RW]
sensitivity_factor[RW]
start_date[RW]
trading_days_per_year[RW]
use_proxy_data[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 70
def self.attribute_map
  {
    :'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',
    :'frequency_interval' => :'frequency_interval',
    :'trading_days_per_year' => :'trading_days_per_year',
    :'sensitivity_factor' => :'sensitivity_factor',
    :'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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 113
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?(:'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?(:'frequency_interval')
    self.frequency_interval = attributes[:'frequency_interval']
  end

  if attributes.has_key?(:'trading_days_per_year')
    self.trading_days_per_year = attributes[:'trading_days_per_year']
  else
    self.trading_days_per_year = 252
  end

  if attributes.has_key?(:'sensitivity_factor')
    self.sensitivity_factor = attributes[:'sensitivity_factor']
  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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 91
def self.swagger_types
  {
    :'allocation_id' => :'String',
    :'end_date' => :'Date',
    :'market_data_source' => :'String',
    :'model_id' => :'String',
    :'account_id' => :'String',
    :'start_date' => :'Date',
    :'frequency_interval' => :'String',
    :'trading_days_per_year' => :'Integer',
    :'sensitivity_factor' => :'SensitivityFactor',
    :'use_proxy_data' => :'BOOLEAN',
    :'portfolio_weights' => :'Array<Float>',
    :'portfolio_tickers' => :'Array<String>',
    :'create_log' => :'BOOLEAN',
    :'aggregation_account_id' => :'String',
    :'portfolio_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 265
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      frequency_interval == o.frequency_interval &&
      trading_days_per_year == o.trading_days_per_year &&
      sensitivity_factor == o.sensitivity_factor &&
      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
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 320
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
_to_hash(value) click to toggle source

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

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 384
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 300
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 287
def eql?(o)
  self == o
end
frequency_interval=(frequency_interval) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] frequency_interval Object to be assigned

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 241
def frequency_interval=(frequency_interval)
  validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', '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
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 293
def hash
  [allocation_id, end_date, market_data_source, model_id, account_id, start_date, frequency_interval, trading_days_per_year, sensitivity_factor, use_proxy_data, portfolio_weights, portfolio_tickers, create_log, aggregation_account_id, portfolio_id].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 194
def list_invalid_properties
  invalid_properties = Array.new
  if @frequency_interval.nil?
    invalid_properties.push('invalid value for "frequency_interval", frequency_interval cannot be nil.')
  end

  if !@trading_days_per_year.nil? && @trading_days_per_year > 365
    invalid_properties.push('invalid value for "trading_days_per_year", must be smaller than or equal to 365.')
  end

  if !@trading_days_per_year.nil? && @trading_days_per_year < 1
    invalid_properties.push('invalid value for "trading_days_per_year", must be greater than or equal to 1.')
  end

  if @sensitivity_factor.nil?
    invalid_properties.push('invalid value for "sensitivity_factor", sensitivity_factor cannot be nil.')
  end

  invalid_properties
end
market_data_source=(market_data_source) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] market_data_source Object to be assigned

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 231
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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 365
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 371
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 359
def to_s
  to_hash.to_s
end
trading_days_per_year=(trading_days_per_year) click to toggle source

Custom attribute writer method with validation @param [Object] trading_days_per_year Value to be assigned

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 251
def trading_days_per_year=(trading_days_per_year)
  if !trading_days_per_year.nil? && trading_days_per_year > 365
    fail ArgumentError, 'invalid value for "trading_days_per_year", must be smaller than or equal to 365.'
  end

  if !trading_days_per_year.nil? && trading_days_per_year < 1
    fail ArgumentError, 'invalid value for "trading_days_per_year", must be greater than or equal to 1.'
  end

  @trading_days_per_year = trading_days_per_year
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/proton_api/models/sensitivity_analysis_request.rb, line 217
def valid?
  market_data_source_validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
  return false unless market_data_source_validator.valid?(@market_data_source)
  return false if @frequency_interval.nil?
  frequency_interval_validator = EnumAttributeValidator.new('String', ['year', 'quarter', 'month', 'week', 'day'])
  return false unless frequency_interval_validator.valid?(@frequency_interval)
  return false if !@trading_days_per_year.nil? && @trading_days_per_year > 365
  return false if !@trading_days_per_year.nil? && @trading_days_per_year < 1
  return false if @sensitivity_factor.nil?
  true
end