Class: ProtonApi::OrderRebalanceRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderRebalanceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 109

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?(:'non_fractional')
    self.non_fractional = attributes[:'non_fractional']
  else
    self.non_fractional = false
  end

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

  if attributes.has_key?(:'buy_threshold')
    self.buy_threshold = attributes[:'buy_threshold']
  else
    self.buy_threshold = 0.0
  end

  if attributes.has_key?(:'commit_orders')
    self.commit_orders = attributes[:'commit_orders']
  else
    self.commit_orders = true
  end

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

  if attributes.has_key?(:'port_threshold')
    self.port_threshold = attributes[:'port_threshold']
  else
    self.port_threshold = 0.0
  end

  if attributes.has_key?(:'use_cash_available')
    self.use_cash_available = attributes[:'use_cash_available']
  else
    self.use_cash_available = false
  end

  if attributes.has_key?(:'use_strategic')
    self.use_strategic = attributes[:'use_strategic']
  else
    self.use_strategic = false
  end

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

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

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

  if attributes.has_key?(:'restrictions_on')
    self.restrictions_on = attributes[:'restrictions_on']
  else
    self.restrictions_on = false
  end

  if attributes.has_key?(:'sell_threshold')
    self.sell_threshold = attributes[:'sell_threshold']
  else
    self.sell_threshold = 0.0
  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/order_rebalance_request.rb', line 25

def 
  @account_id
end

#buy_threshold ⇒ Object

Returns the value of attribute buy_threshold.



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

def buy_threshold
  @buy_threshold
end

#buy_transaction_code_id ⇒ Object

Returns the value of attribute buy_transaction_code_id.



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

def buy_transaction_code_id
  @buy_transaction_code_id
end

#cash_portfolio_id ⇒ Object

Returns the value of attribute cash_portfolio_id.



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

def cash_portfolio_id
  @cash_portfolio_id
end

#commit_orders ⇒ Object

Returns the value of attribute commit_orders.



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

def commit_orders
  @commit_orders
end

#non_fractional ⇒ Object

Returns the value of attribute non_fractional.



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

def non_fractional
  @non_fractional
end

#order_scope ⇒ Object

Returns the value of attribute order_scope.



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

def order_scope
  @order_scope
end

#port_threshold ⇒ Object

Returns the value of attribute port_threshold.



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

def port_threshold
  @port_threshold
end

#portfolio_id ⇒ Object

Returns the value of attribute portfolio_id.



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

def portfolio_id
  @portfolio_id
end

#restrictions_on ⇒ Object

Returns the value of attribute restrictions_on.



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

def restrictions_on
  @restrictions_on
end

#sell_threshold ⇒ Object

Returns the value of attribute sell_threshold.



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

def sell_threshold
  @sell_threshold
end

#sell_transaction_code_id ⇒ Object

Returns the value of attribute sell_transaction_code_id.



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

def sell_transaction_code_id
  @sell_transaction_code_id
end

#use_cash_available ⇒ Object

Returns the value of attribute use_cash_available.



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

def use_cash_available
  @use_cash_available
end

#use_strategic ⇒ Object

Returns the value of attribute use_strategic.



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

def use_strategic
  @use_strategic
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 68

def self.attribute_map
  {
    :'non_fractional' => :'non_fractional',
    :'order_scope' => :'order_scope',
    :'buy_threshold' => :'buy_threshold',
    :'commit_orders' => :'commit_orders',
    :'account_id' => :'account_id',
    :'port_threshold' => :'port_threshold',
    :'use_cash_available' => :'use_cash_available',
    :'use_strategic' => :'use_strategic',
    :'sell_transaction_code_id' => :'sell_transaction_code_id',
    :'buy_transaction_code_id' => :'buy_transaction_code_id',
    :'cash_portfolio_id' => :'cash_portfolio_id',
    :'restrictions_on' => :'restrictions_on',
    :'sell_threshold' => :'sell_threshold',
    :'portfolio_id' => :'portfolio_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 88

def self.swagger_types
  {
    :'non_fractional' => :'BOOLEAN',
    :'order_scope' => :'String',
    :'buy_threshold' => :'Float',
    :'commit_orders' => :'BOOLEAN',
    :'account_id' => :'String',
    :'port_threshold' => :'Float',
    :'use_cash_available' => :'BOOLEAN',
    :'use_strategic' => :'BOOLEAN',
    :'sell_transaction_code_id' => :'String',
    :'buy_transaction_code_id' => :'String',
    :'cash_portfolio_id' => :'String',
    :'restrictions_on' => :'BOOLEAN',
    :'sell_threshold' => :'Float',
    :'portfolio_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      non_fractional == o.non_fractional &&
      order_scope == o.order_scope &&
      buy_threshold == o.buy_threshold &&
      commit_orders == o.commit_orders &&
       == o. &&
      port_threshold == o.port_threshold &&
      use_cash_available == o.use_cash_available &&
      use_strategic == o.use_strategic &&
      sell_transaction_code_id == o.sell_transaction_code_id &&
      buy_transaction_code_id == o.buy_transaction_code_id &&
      cash_portfolio_id == o.cash_portfolio_id &&
      restrictions_on == o.restrictions_on &&
      sell_threshold == o.sell_threshold &&
      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



319
320
321
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
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 319

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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 383

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



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

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


286
287
288
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



292
293
294
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 292

def hash
  [non_fractional, order_scope, buy_threshold, commit_orders, , port_threshold, use_cash_available, use_strategic, sell_transaction_code_id, buy_transaction_code_id, cash_portfolio_id, restrictions_on, sell_threshold, 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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 190

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

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

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

  if !@sell_threshold.nil? && @sell_threshold < 1
    invalid_properties.push('invalid value for "sell_threshold", 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



364
365
366
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 364

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



370
371
372
373
374
375
376
377
378
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 370

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



358
359
360
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 358

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



213
214
215
216
217
218
219
220
221
 
# File 'lib/proton_api/models/order_rebalance_request.rb', line 213

def valid?
  return false if @order_scope.nil?
  order_scope_validator = EnumAttributeValidator.new('String', ['all', 'buy_only', 'sell_only'])
  return false unless order_scope_validator.valid?(@order_scope)
  return false if !@buy_threshold.nil? && @buy_threshold < 0
  return false if !@port_threshold.nil? && @port_threshold < 0
  return false if !@sell_threshold.nil? && @sell_threshold < 1
  true
end