Class: ProtonApi::EventStudyRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EventStudyRequest

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
157
158
 
# File 'lib/proton_api/models/event_study_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?(:'allocation_id')
    self.allocation_id = attributes[:'allocation_id']
  end

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

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_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?(:'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.



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

def 
  @account_id
end

#aggregation_account_id ⇒ Object

Returns the value of attribute aggregation_account_id.



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

def 
  @aggregation_account_id
end

#allocation_id ⇒ Object

Returns the value of attribute allocation_id.



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

def allocation_id
  @allocation_id
end

#create_log ⇒ Object

Returns the value of attribute create_log.



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

def create_log
  @create_log
end

#events ⇒ Object

Returns the value of attribute events.



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

def events
  @events
end

#market_data_source ⇒ Object

Returns the value of attribute market_data_source.



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

def market_data_source
  @market_data_source
end

#model_id ⇒ Object

Returns the value of attribute model_id.



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

def model_id
  @model_id
end

#portfolio_id ⇒ Object

Returns the value of attribute portfolio_id.



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

def portfolio_id
  @portfolio_id
end

#portfolio_tickers ⇒ Object

Returns the value of attribute portfolio_tickers.



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

def portfolio_tickers
  @portfolio_tickers
end

#portfolio_weights ⇒ Object

Returns the value of attribute portfolio_weights.



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

def portfolio_weights
  @portfolio_weights
end

#use_proxy_data ⇒ Object

Returns the value of attribute use_proxy_data.



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

def use_proxy_data
  @use_proxy_data
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/event_study_request.rb', line 62

def self.attribute_map
  {
    :'allocation_id' => :'allocation_id',
    :'events' => :'events',
    :'market_data_source' => :'market_data_source',
    :'model_id' => :'model_id',
    :'account_id' => :'account_id',
    :'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.



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

def self.swagger_types
  {
    :'allocation_id' => :'String',
    :'events' => :'Array<String>',
    :'market_data_source' => :'String',
    :'model_id' => :'String',
    :'account_id' => :'String',
    :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allocation_id == o.allocation_id &&
      events == o.events &&
      market_data_source == o.market_data_source &&
      model_id == o.model_id &&
       == o. &&
      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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/proton_api/models/event_study_request.rb', line 238

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



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

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/proton_api/models/event_study_request.rb', line 218

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


205
206
207
 
# File 'lib/proton_api/models/event_study_request.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/proton_api/models/event_study_request.rb', line 211

def hash
  [allocation_id, events, market_data_source, model_id, , 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



162
163
164
165
 
# File 'lib/proton_api/models/event_study_request.rb', line 162

def list_invalid_properties
  invalid_properties = Array.new
  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



283
284
285
 
# File 'lib/proton_api/models/event_study_request.rb', line 283

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



289
290
291
292
293
294
295
296
297
 
# File 'lib/proton_api/models/event_study_request.rb', line 289

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



277
278
279
 
# File 'lib/proton_api/models/event_study_request.rb', line 277

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



169
170
171
172
173
 
# File 'lib/proton_api/models/event_study_request.rb', line 169

def valid?
  market_data_source_validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
  return false unless market_data_source_validator.valid?(@market_data_source)
  true
end