Class: RakutenTrading::OrderDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/rakuten_trading/models/order_detail.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
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
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 144

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `RakutenTrading::OrderDetail` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `RakutenTrading::OrderDetail`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'symbol_id')
    self.symbol_id = attributes[:'symbol_id']
  end

  if attributes.key?(:'order_behavior')
    self.order_behavior = attributes[:'order_behavior']
  end

  if attributes.key?(:'order_side')
    self.order_side = attributes[:'order_side']
  end

  if attributes.key?(:'order_pattern')
    self.order_pattern = attributes[:'order_pattern']
  end

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

  if attributes.key?(:'close_behavior')
    self.close_behavior = attributes[:'close_behavior']
  end

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

  if attributes.key?(:'average_price')
    self.average_price = attributes[:'average_price']
  end

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

  if attributes.key?(:'remaining_amount')
    self.remaining_amount = attributes[:'remaining_amount']
  end

  if attributes.key?(:'order_status')
    self.order_status = attributes[:'order_status']
  end

  if attributes.key?(:'post_only')
    self.post_only = attributes[:'post_only']
  end

  if attributes.key?(:'oco1_order_id')
    self.oco1_order_id = attributes[:'oco1_order_id']
  end

  if attributes.key?(:'oco2_order_id')
    self.oco2_order_id = attributes[:'oco2_order_id']
  end

  if attributes.key?(:'ifd_open_order_id')
    self.ifd_open_order_id = attributes[:'ifd_open_order_id']
  end

  if attributes.key?(:'ifd_close_limit_price')
    self.ifd_close_limit_price = attributes[:'ifd_close_limit_price']
  end

  if attributes.key?(:'ifd_close_stop_price')
    self.ifd_close_stop_price = attributes[:'ifd_close_stop_price']
  end

  if attributes.key?(:'position_id')
    self.position_id = attributes[:'position_id']
  end

  if attributes.key?(:'order_expire')
    self.order_expire = attributes[:'order_expire']
  end

  if attributes.key?(:'expire_business_date')
    self.expire_business_date = attributes[:'expire_business_date']
  end

  if attributes.key?(:'leverage')
    self.leverage = attributes[:'leverage']
  end

  if attributes.key?(:'necessary_margin')
    self.necessary_margin = attributes[:'necessary_margin']
  end

  if attributes.key?(:'business_date')
    self.business_date = attributes[:'business_date']
  end

  if attributes.key?(:'order_created_at')
    self.order_created_at = attributes[:'order_created_at']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end
end

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



34
35
36
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 34

def amount
  @amount
end

#average_price ⇒ Object

Returns the value of attribute average_price.



32
33
34
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 32

def average_price
  @average_price
end

#business_date ⇒ Object

Returns the value of attribute business_date.



62
63
64
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 62

def business_date
  @business_date
end

#close_behavior ⇒ Object

Returns the value of attribute close_behavior.



28
29
30
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 28

def close_behavior
  @close_behavior
end

#created_at ⇒ Object

Returns the value of attribute created_at.



66
67
68
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 66

def created_at
  @created_at
end

#expire_business_date ⇒ Object

Returns the value of attribute expire_business_date.



56
57
58
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 56

def expire_business_date
  @expire_business_date
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 16

def id
  @id
end

#ifd_close_limit_price ⇒ Object

Returns the value of attribute ifd_close_limit_price.



48
49
50
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 48

def ifd_close_limit_price
  @ifd_close_limit_price
end

#ifd_close_stop_price ⇒ Object

Returns the value of attribute ifd_close_stop_price.



50
51
52
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 50

def ifd_close_stop_price
  @ifd_close_stop_price
end

#ifd_open_order_id ⇒ Object

Returns the value of attribute ifd_open_order_id.



46
47
48
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 46

def ifd_open_order_id
  @ifd_open_order_id
end

#leverage ⇒ Object

Returns the value of attribute leverage.



58
59
60
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 58

def leverage
  @leverage
end

#necessary_margin ⇒ Object

Returns the value of attribute necessary_margin.



60
61
62
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 60

def necessary_margin
  @necessary_margin
end

#oco1_order_id ⇒ Object

Returns the value of attribute oco1_order_id.



42
43
44
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 42

def oco1_order_id
  @oco1_order_id
end

#oco2_order_id ⇒ Object

Returns the value of attribute oco2_order_id.



44
45
46
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 44

def oco2_order_id
  @oco2_order_id
end

#order_behavior ⇒ Object

Returns the value of attribute order_behavior.



20
21
22
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 20

def order_behavior
  @order_behavior
end

#order_created_at ⇒ Object

Returns the value of attribute order_created_at.



64
65
66
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 64

def order_created_at
  @order_created_at
end

#order_expire ⇒ Object

Returns the value of attribute order_expire.



54
55
56
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 54

def order_expire
  @order_expire
end

#order_pattern ⇒ Object

Returns the value of attribute order_pattern.



24
25
26
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 24

def order_pattern
  @order_pattern
end

#order_side ⇒ Object

Returns the value of attribute order_side.



22
23
24
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 22

def order_side
  @order_side
end

#order_status ⇒ Object

Returns the value of attribute order_status.



38
39
40
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 38

def order_status
  @order_status
end

#order_type ⇒ Object

Returns the value of attribute order_type.



26
27
28
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 26

def order_type
  @order_type
end

#position_id ⇒ Object

Returns the value of attribute position_id.



52
53
54
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 52

def position_id
  @position_id
end

#post_only ⇒ Object

Returns the value of attribute post_only.



40
41
42
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 40

def post_only
  @post_only
end

#price ⇒ Object

Returns the value of attribute price.



30
31
32
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 30

def price
  @price
end

#remaining_amount ⇒ Object

Returns the value of attribute remaining_amount.



36
37
38
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 36

def remaining_amount
  @remaining_amount
end

#symbol_id ⇒ Object

Returns the value of attribute symbol_id.



18
19
20
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 18

def symbol_id
  @symbol_id
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



68
69
70
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 68

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 71

def self.attribute_map
  {
    :'id' => :'id',
    :'symbol_id' => :'symbolId',
    :'order_behavior' => :'orderBehavior',
    :'order_side' => :'orderSide',
    :'order_pattern' => :'orderPattern',
    :'order_type' => :'orderType',
    :'close_behavior' => :'closeBehavior',
    :'price' => :'price',
    :'average_price' => :'averagePrice',
    :'amount' => :'amount',
    :'remaining_amount' => :'remainingAmount',
    :'order_status' => :'orderStatus',
    :'post_only' => :'postOnly',
    :'oco1_order_id' => :'oco1OrderId',
    :'oco2_order_id' => :'oco2OrderId',
    :'ifd_open_order_id' => :'ifdOpenOrderId',
    :'ifd_close_limit_price' => :'ifdCloseLimitPrice',
    :'ifd_close_stop_price' => :'ifdCloseStopPrice',
    :'position_id' => :'positionId',
    :'order_expire' => :'orderExpire',
    :'expire_business_date' => :'expireBusinessDate',
    :'leverage' => :'leverage',
    :'necessary_margin' => :'necessaryMargin',
    :'business_date' => :'businessDate',
    :'order_created_at' => :'orderCreatedAt',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
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



328
329
330
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 328

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



137
138
139
140
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 137

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 104

def self.openapi_types
  {
    :'id' => :'Object',
    :'symbol_id' => :'Object',
    :'order_behavior' => :'Object',
    :'order_side' => :'Object',
    :'order_pattern' => :'Object',
    :'order_type' => :'Object',
    :'close_behavior' => :'Object',
    :'price' => :'Object',
    :'average_price' => :'Object',
    :'amount' => :'Object',
    :'remaining_amount' => :'Object',
    :'order_status' => :'Object',
    :'post_only' => :'Object',
    :'oco1_order_id' => :'Object',
    :'oco2_order_id' => :'Object',
    :'ifd_open_order_id' => :'Object',
    :'ifd_close_limit_price' => :'Object',
    :'ifd_close_stop_price' => :'Object',
    :'position_id' => :'Object',
    :'order_expire' => :'Object',
    :'expire_business_date' => :'Object',
    :'leverage' => :'Object',
    :'necessary_margin' => :'Object',
    :'business_date' => :'Object',
    :'order_created_at' => :'Object',
    :'created_at' => :'Object',
    :'updated_at' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
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
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      symbol_id == o.symbol_id &&
      order_behavior == o.order_behavior &&
      order_side == o.order_side &&
      order_pattern == o.order_pattern &&
      order_type == o.order_type &&
      close_behavior == o.close_behavior &&
      price == o.price &&
      average_price == o.average_price &&
      amount == o.amount &&
      remaining_amount == o.remaining_amount &&
      order_status == o.order_status &&
      post_only == o.post_only &&
      oco1_order_id == o.oco1_order_id &&
      oco2_order_id == o.oco2_order_id &&
      ifd_open_order_id == o.ifd_open_order_id &&
      ifd_close_limit_price == o.ifd_close_limit_price &&
      ifd_close_stop_price == o.ifd_close_stop_price &&
      position_id == o.position_id &&
      order_expire == o.order_expire &&
      expire_business_date == o.expire_business_date &&
      leverage == o.leverage &&
      necessary_margin == o.necessary_margin &&
      business_date == o.business_date &&
      order_created_at == o.order_created_at &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 358

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(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
    RakutenTrading.const_get(type).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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 427

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 335

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


315
316
317
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 315

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



321
322
323
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 321

def hash
  [id, symbol_id, order_behavior, order_side, order_pattern, order_type, close_behavior, price, average_price, amount, remaining_amount, order_status, post_only, oco1_order_id, oco2_order_id, ifd_open_order_id, ifd_close_limit_price, ifd_close_stop_price, position_id, order_expire, expire_business_date, leverage, necessary_margin, business_date, order_created_at, created_at, updated_at].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



268
269
270
271
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 268

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



403
404
405
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 403

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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 409

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



397
398
399
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 397

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



275
276
277
 
# File 'lib/rakuten_trading/models/order_detail.rb', line 275

def valid?
  true
end