Class: ProtonApi::MvoRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MvoRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/proton_api/models/mvo_request.rb', line 97

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?(:'tickers')
    if (value = attributes[:'tickers']).is_a?(Array)
      self.tickers = value
    end
  end

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

  if attributes.has_key?(:'min_assets')
    self.min_assets = attributes[:'min_assets']
  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?(:'w_asset_config')
    self.w_asset_config = attributes[:'w_asset_config']
  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']
  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?(:'tgt_val')
    self.tgt_val = attributes[:'tgt_val']
  else
    self.tgt_val = 0.0
  end

  if attributes.has_key?(:'sec_types')
    if (value = attributes[:'sec_types']).is_a?(Array)
      self.sec_types = value
    end
  end
end

Instance Attribute Details

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#market_data_source ⇒ Object

Returns the value of attribute market_data_source.



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

def market_data_source
  @market_data_source
end

#min_assets ⇒ Object

Returns the value of attribute min_assets.



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

def min_assets
  @min_assets
end

#sec_types ⇒ Object

Returns the value of attribute sec_types.



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

def sec_types
  @sec_types
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#tgt_type ⇒ Object

Returns the value of attribute tgt_type.



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

def tgt_type
  @tgt_type
end

#tgt_val ⇒ Object

Returns the value of attribute tgt_val.



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

def tgt_val
  @tgt_val
end

#tickers ⇒ Object

Returns the value of attribute tickers.



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

def tickers
  @tickers
end

#use_proxy_data ⇒ Object

Returns the value of attribute use_proxy_data.



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

def use_proxy_data
  @use_proxy_data
end

#w_asset_config ⇒ Object

Returns the value of attribute w_asset_config.



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

def w_asset_config
  @w_asset_config
end

#w_config ⇒ Object

Returns the value of attribute w_config.



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

def w_config
  @w_config
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/proton_api/models/mvo_request.rb', line 62

def self.attribute_map
  {
    :'tickers' => :'tickers',
    :'w_config' => :'w_config',
    :'min_assets' => :'min_assets',
    :'end_date' => :'end_date',
    :'market_data_source' => :'market_data_source',
    :'w_asset_config' => :'w_asset_config',
    :'start_date' => :'start_date',
    :'tgt_type' => :'tgt_type',
    :'use_proxy_data' => :'use_proxy_data',
    :'tgt_val' => :'tgt_val',
    :'sec_types' => :'sec_types'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/proton_api/models/mvo_request.rb', line 79

def self.swagger_types
  {
    :'tickers' => :'Array<String>',
    :'w_config' => :'WConfig',
    :'min_assets' => :'Integer',
    :'end_date' => :'Date',
    :'market_data_source' => :'String',
    :'w_asset_config' => :'Object',
    :'start_date' => :'Date',
    :'tgt_type' => :'String',
    :'use_proxy_data' => :'BOOLEAN',
    :'tgt_val' => :'Float',
    :'sec_types' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/proton_api/models/mvo_request.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tickers == o.tickers &&
      w_config == o.w_config &&
      min_assets == o.min_assets &&
      end_date == o.end_date &&
      market_data_source == o.market_data_source &&
      w_asset_config == o.w_asset_config &&
      start_date == o.start_date &&
      tgt_type == o.tgt_type &&
      use_proxy_data == o.use_proxy_data &&
      tgt_val == o.tgt_val &&
      sec_types == o.sec_types
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/proton_api/models/mvo_request.rb', line 287

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/proton_api/models/mvo_request.rb', line 351

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



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

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


254
255
256
 
# File 'lib/proton_api/models/mvo_request.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/proton_api/models/mvo_request.rb', line 260

def hash
  [tickers, w_config, min_assets, end_date, market_data_source, w_asset_config, start_date, tgt_type, use_proxy_data, tgt_val, sec_types].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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/proton_api/models/mvo_request.rb', line 160

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

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

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

  if @min_assets < 1
    invalid_properties.push('invalid value for "min_assets", must be greater than or equal to 1.')
  end

  if @sec_types.nil?
    invalid_properties.push('invalid value for "sec_types", sec_types cannot be nil.')
  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



332
333
334
 
# File 'lib/proton_api/models/mvo_request.rb', line 332

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



338
339
340
341
342
343
344
345
346
 
# File 'lib/proton_api/models/mvo_request.rb', line 338

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



326
327
328
 
# File 'lib/proton_api/models/mvo_request.rb', line 326

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



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/proton_api/models/mvo_request.rb', line 187

def valid?
  return false if @tickers.nil?
  return false if @w_config.nil?
  return false if @min_assets.nil?
  return false if @min_assets < 1
  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)
  return false if @sec_types.nil?
  true
end