Class: NucleusApi::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/order.rb

Overview

Order Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/nucleus_api/models/order.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

accountId



19
20
21
 
# File 'lib/nucleus_api/models/order.rb', line 19

def 
  @account_id
end

#amount ⇒ Object

amount



22
23
24
 
# File 'lib/nucleus_api/models/order.rb', line 22

def amount
  @amount
end

#commission ⇒ Object

commission



25
26
27
 
# File 'lib/nucleus_api/models/order.rb', line 25

def commission
  @commission
end

#create_date ⇒ Object

Returns the value of attribute create_date.



27
28
29
 
# File 'lib/nucleus_api/models/order.rb', line 27

def create_date
  @create_date
end

#date ⇒ Object

date



30
31
32
 
# File 'lib/nucleus_api/models/order.rb', line 30

def date
  @date
end

#id ⇒ Object

Returns the value of attribute id.



32
33
34
 
# File 'lib/nucleus_api/models/order.rb', line 32

def id
  @id
end

#is_read ⇒ Object

isRead



35
36
37
 
# File 'lib/nucleus_api/models/order.rb', line 35

def is_read
  @is_read
end

#metadata ⇒ Object

metadata



38
39
40
 
# File 'lib/nucleus_api/models/order.rb', line 38

def metadata
  @metadata
end

#model_id ⇒ Object

modelId



41
42
43
 
# File 'lib/nucleus_api/models/order.rb', line 41

def model_id
  @model_id
end

#order_bulk_id ⇒ Object

orderBulkId



44
45
46
 
# File 'lib/nucleus_api/models/order.rb', line 44

def order_bulk_id
  @order_bulk_id
end

#order_ticket_id ⇒ Object

orderTicketId



47
48
49
 
# File 'lib/nucleus_api/models/order.rb', line 47

def order_ticket_id
  @order_ticket_id
end

#order_type ⇒ Object

orderType



50
51
52
 
# File 'lib/nucleus_api/models/order.rb', line 50

def order_type
  @order_type
end

#portfolio_id ⇒ Object

portfolioId



53
54
55
 
# File 'lib/nucleus_api/models/order.rb', line 53

def portfolio_id
  @portfolio_id
end

#price ⇒ Object

price



56
57
58
 
# File 'lib/nucleus_api/models/order.rb', line 56

def price
  @price
end

#quantity ⇒ Object

quantity



59
60
61
 
# File 'lib/nucleus_api/models/order.rb', line 59

def quantity
  @quantity
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



61
62
63
 
# File 'lib/nucleus_api/models/order.rb', line 61

def secondary_id
  @secondary_id
end

#security_id ⇒ Object

securityId



64
65
66
 
# File 'lib/nucleus_api/models/order.rb', line 64

def security_id
  @security_id
end

#tmp_tracker_id ⇒ Object

Returns the value of attribute tmp_tracker_id.



66
67
68
 
# File 'lib/nucleus_api/models/order.rb', line 66

def tmp_tracker_id
  @tmp_tracker_id
end

#transaction_code_id ⇒ Object

transactionCodeId



69
70
71
 
# File 'lib/nucleus_api/models/order.rb', line 69

def transaction_code_id
  @transaction_code_id
end

#update_date ⇒ Object

Returns the value of attribute update_date.



71
72
73
 
# File 'lib/nucleus_api/models/order.rb', line 71

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/nucleus_api/models/order.rb', line 74

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'commission' => :'commission',
    :'create_date' => :'create_date',
    :'date' => :'date',
    :'id' => :'id',
    :'is_read' => :'is_read',
    :'metadata' => :'metadata',
    :'model_id' => :'model_id',
    :'order_bulk_id' => :'order_bulk_id',
    :'order_ticket_id' => :'order_ticket_id',
    :'order_type' => :'order_type',
    :'portfolio_id' => :'portfolio_id',
    :'price' => :'price',
    :'quantity' => :'quantity',
    :'secondary_id' => :'secondary_id',
    :'security_id' => :'security_id',
    :'tmp_tracker_id' => :'tmp_tracker_id',
    :'transaction_code_id' => :'transaction_code_id',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/nucleus_api/models/order.rb', line 100

def self.swagger_types
  {
    :'account_id' => :'String',
    :'amount' => :'Float',
    :'commission' => :'Float',
    :'create_date' => :'DateTime',
    :'date' => :'Date',
    :'id' => :'String',
    :'is_read' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'model_id' => :'String',
    :'order_bulk_id' => :'String',
    :'order_ticket_id' => :'String',
    :'order_type' => :'String',
    :'portfolio_id' => :'String',
    :'price' => :'Float',
    :'quantity' => :'Float',
    :'secondary_id' => :'String',
    :'security_id' => :'String',
    :'tmp_tracker_id' => :'String',
    :'transaction_code_id' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/nucleus_api/models/order.rb', line 251

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      commission == o.commission &&
      create_date == o.create_date &&
      date == o.date &&
      id == o.id &&
      is_read == o.is_read &&
      metadata == o.metadata &&
      model_id == o.model_id &&
      order_bulk_id == o.order_bulk_id &&
      order_ticket_id == o.order_ticket_id &&
      order_type == o.order_type &&
      portfolio_id == o.portfolio_id &&
      price == o.price &&
      quantity == o.quantity &&
      secondary_id == o.secondary_id &&
      security_id == o.security_id &&
      tmp_tracker_id == o.tmp_tracker_id &&
      transaction_code_id == o.transaction_code_id &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



310
311
312
313
314
315
316
317
318
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
 
# File 'lib/nucleus_api/models/order.rb', line 310

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 = NucleusApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of 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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/nucleus_api/models/order.rb', line 376

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/nucleus_api/models/order.rb', line 291

def build_from_hash(attributes)
  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


278
279
280
 
# File 'lib/nucleus_api/models/order.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/nucleus_api/models/order.rb', line 284

def hash
  [, amount, commission, create_date, date, id, is_read, metadata, model_id, order_bulk_id, order_ticket_id, order_type, portfolio_id, price, quantity, secondary_id, security_id, tmp_tracker_id, transaction_code_id, update_date].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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/nucleus_api/models/order.rb', line 218

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

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

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

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



357
358
359
 
# File 'lib/nucleus_api/models/order.rb', line 357

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



363
364
365
366
367
368
369
370
 
# File 'lib/nucleus_api/models/order.rb', line 363

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



351
352
353
 
# File 'lib/nucleus_api/models/order.rb', line 351

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



241
242
243
244
245
246
247
 
# File 'lib/nucleus_api/models/order.rb', line 241

def valid?
  return false if @date.nil?
  return false if @order_ticket_id.nil?
  return false if @security_id.nil?
  return false if @transaction_code_id.nil?
  true
end