Class: RakutenTrading::OrderResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `RakutenTrading::OrderResponse` 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::OrderResponse`. 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?(:'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?(:'leverage')
    self.leverage = attributes[:'leverage']
  end

  if attributes.key?(:'necessary_margin')
    self.necessary_margin = attributes[:'necessary_margin']
  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

注文数量



41
42
43
 
# File 'lib/rakuten_trading/models/order_response.rb', line 41

def amount
  @amount
end

#average_price ⇒ Object

平均約定価格



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

def average_price
  @average_price
end

#created_at ⇒ Object

注文作成日時



80
81
82
 
# File 'lib/rakuten_trading/models/order_response.rb', line 80

def created_at
  @created_at
end

#id ⇒ Object

注文ID



17
18
19
 
# File 'lib/rakuten_trading/models/order_response.rb', line 17

def id
  @id
end

#ifd_close_limit_price ⇒ Object

IFD決済指値注文価格



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

def ifd_close_limit_price
  @ifd_close_limit_price
end

#ifd_close_stop_price ⇒ Object

IFD決済逆指値注文価格



65
66
67
 
# File 'lib/rakuten_trading/models/order_response.rb', line 65

def ifd_close_stop_price
  @ifd_close_stop_price
end

#ifd_open_order_id ⇒ Object

IFD新規注文ID



59
60
61
 
# File 'lib/rakuten_trading/models/order_response.rb', line 59

def ifd_open_order_id
  @ifd_open_order_id
end

#leverage ⇒ Object

レバレッジ倍率



74
75
76
 
# File 'lib/rakuten_trading/models/order_response.rb', line 74

def leverage
  @leverage
end

#necessary_margin ⇒ Object

注文中証拠金



77
78
79
 
# File 'lib/rakuten_trading/models/order_response.rb', line 77

def necessary_margin
  @necessary_margin
end

#oco1_order_id ⇒ Object

OCO1注文ID



53
54
55
 
# File 'lib/rakuten_trading/models/order_response.rb', line 53

def oco1_order_id
  @oco1_order_id
end

#oco2_order_id ⇒ Object

OCO2注文ID



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

def oco2_order_id
  @oco2_order_id
end

#order_behavior ⇒ Object

注文の種類（新規または決済）



23
24
25
 
# File 'lib/rakuten_trading/models/order_response.rb', line 23

def order_behavior
  @order_behavior
end

#order_expire ⇒ Object

有効期限タイプ



71
72
73
 
# File 'lib/rakuten_trading/models/order_response.rb', line 71

def order_expire
  @order_expire
end

#order_pattern ⇒ Object

注文パターン（NORMAL, OCO, IFD, IFD_OCO）



29
30
31
 
# File 'lib/rakuten_trading/models/order_response.rb', line 29

def order_pattern
  @order_pattern
end

#order_side ⇒ Object

売買方向（BUYまたはSELL）



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

def order_side
  @order_side
end

#order_status ⇒ Object

注文ステータス（WORKING_ORDER, PARTIAL_FILL等）



47
48
49
 
# File 'lib/rakuten_trading/models/order_response.rb', line 47

def order_status
  @order_status
end

#order_type ⇒ Object

注文タイプ（LIMIT, MARKET, STOP）



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

def order_type
  @order_type
end

#position_id ⇒ Object

決済対象建玉ID



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

def position_id
  @position_id
end

#post_only ⇒ Object

メイカー注文のみ許可されたかどうか



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

def post_only
  @post_only
end

#price ⇒ Object

注文価格



35
36
37
 
# File 'lib/rakuten_trading/models/order_response.rb', line 35

def price
  @price
end

#remaining_amount ⇒ Object

未約定数量



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

def remaining_amount
  @remaining_amount
end

#symbol_id ⇒ Object

シンボルID



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

def symbol_id
  @symbol_id
end

#updated_at ⇒ Object

注文更新日時



83
84
85
 
# File 'lib/rakuten_trading/models/order_response.rb', line 83

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/rakuten_trading/models/order_response.rb', line 86

def self.attribute_map
  {
    :'id' => :'id',
    :'symbol_id' => :'symbolId',
    :'order_behavior' => :'orderBehavior',
    :'order_side' => :'orderSide',
    :'order_pattern' => :'orderPattern',
    :'order_type' => :'orderType',
    :'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',
    :'leverage' => :'leverage',
    :'necessary_margin' => :'necessaryMargin',
    :'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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
 
# File 'lib/rakuten_trading/models/order_response.rb', line 144

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Object',
    :'symbol_id' => :'Object',
    :'order_behavior' => :'Object',
    :'order_side' => :'Object',
    :'order_pattern' => :'Object',
    :'order_type' => :'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',
    :'leverage' => :'Object',
    :'necessary_margin' => :'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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/rakuten_trading/models/order_response.rb', line 272

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 &&
      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 &&
      leverage == o.leverage &&
      necessary_margin == o.necessary_margin &&
      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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/rakuten_trading/models/order_response.rb', line 345

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/rakuten_trading/models/order_response.rb', line 414

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/rakuten_trading/models/order_response.rb', line 322

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


302
303
304
 
# File 'lib/rakuten_trading/models/order_response.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/rakuten_trading/models/order_response.rb', line 308

def hash
  [id, symbol_id, order_behavior, order_side, order_pattern, order_type, 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, leverage, necessary_margin, 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



259
260
261
262
 
# File 'lib/rakuten_trading/models/order_response.rb', line 259

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



390
391
392
 
# File 'lib/rakuten_trading/models/order_response.rb', line 390

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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/rakuten_trading/models/order_response.rb', line 396

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



384
385
386
 
# File 'lib/rakuten_trading/models/order_response.rb', line 384

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



266
267
268
 
# File 'lib/rakuten_trading/models/order_response.rb', line 266

def valid?
  true
end