Class: ProtonApi::ScenarioAnalysisRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/scenario_analysis_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScenarioAnalysisRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/proton_api/models/scenario_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?(:'scenario')
    if (value = attributes[:'scenario']).is_a?(Array)
      self.scenario = value
    end
  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. = 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?(:'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. = attributes[:'aggregation_account_id']
  end

  if attributes.has_key?(:'portfolio_id')
    self.portfolio_id = attributes[:'portfolio_id']
  end
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



27
28
29
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 27

def 
  @account_id
end

#aggregation_account_id ⇒ Object

Returns the value of attribute aggregation_account_id.



43
44
45
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 43

def 
  @aggregation_account_id
end

#allocation_id ⇒ Object

Returns the value of attribute allocation_id.



19
20
21
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 19

def allocation_id
  @allocation_id
end

#create_log ⇒ Object

Returns the value of attribute create_log.



41
42
43
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 41

def create_log
  @create_log
end

#end_date ⇒ Object

Returns the value of attribute end_date.



21
22
23
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 21

def end_date
  @end_date
end

#frequency_interval ⇒ Object

Returns the value of attribute frequency_interval.



31
32
33
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 31

def frequency_interval
  @frequency_interval
end

#market_data_source ⇒ Object

Returns the value of attribute market_data_source.



23
24
25
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 23

def market_data_source
  @market_data_source
end

#model_id ⇒ Object

Returns the value of attribute model_id.



25
26
27
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 25

def model_id
  @model_id
end

#portfolio_id ⇒ Object

Returns the value of attribute portfolio_id.



45
46
47
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 45

def portfolio_id
  @portfolio_id
end

#portfolio_tickers ⇒ Object

Returns the value of attribute portfolio_tickers.



39
40
41
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 39

def portfolio_tickers
  @portfolio_tickers
end

#portfolio_weights ⇒ Object

Returns the value of attribute portfolio_weights.



37
38
39
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 37

def portfolio_weights
  @portfolio_weights
end

#scenario ⇒ Object

Returns the value of attribute scenario.



17
18
19
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 17

def scenario
  @scenario
end

#start_date ⇒ Object

Returns the value of attribute start_date.



29
30
31
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 29

def start_date
  @start_date
end

#trading_days_per_year ⇒ Object

Returns the value of attribute trading_days_per_year.



33
34
35
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 33

def trading_days_per_year
  @trading_days_per_year
end

#use_proxy_data ⇒ Object

Returns the value of attribute use_proxy_data.



35
36
37
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 35

def use_proxy_data
  @use_proxy_data
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 70

def self.attribute_map
  {
    :'scenario' => :'scenario',
    :'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',
    :'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

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 91

def self.swagger_types
  {
    :'scenario' => :'Array<SensitivityFactor>',
    :'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',
    :'use_proxy_data' => :'BOOLEAN',
    :'portfolio_weights' => :'Array<Float>',
    :'portfolio_tickers' => :'Array<String>',
    :'create_log' => :'BOOLEAN',
    :'aggregation_account_id' => :'String',
    :'portfolio_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      scenario == o.scenario &&
      allocation_id == o.allocation_id &&
      end_date == o.end_date &&
      market_data_source == o.market_data_source &&
      model_id == o.model_id &&
       == o. &&
      start_date == o.start_date &&
      frequency_interval == o.frequency_interval &&
      trading_days_per_year == o.trading_days_per_year &&
      use_proxy_data == o.use_proxy_data &&
      portfolio_weights == o.portfolio_weights &&
      portfolio_tickers == o.portfolio_tickers &&
      create_log == o.create_log &&
       == o. &&
      portfolio_id == o.portfolio_id
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 322

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) ⇒ Hash

For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 386

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 302

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


289
290
291
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 295

def hash
  [scenario, allocation_id, end_date, market_data_source, model_id, , start_date, frequency_interval, trading_days_per_year, use_proxy_data, portfolio_weights, portfolio_tickers, create_log, , portfolio_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 196

def list_invalid_properties
  invalid_properties = Array.new
  if @scenario.nil?
    invalid_properties.push('invalid value for "scenario", scenario cannot be nil.')
  end

  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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



367
368
369
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 367

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
376
377
378
379
380
381
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 373

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 ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



361
362
363
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 361

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/proton_api/models/scenario_analysis_request.rb', line 219

def valid?
  return false if @scenario.nil?
  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
  true
end