Class: KabustationClient::OrdersSuccess

Inherits:
Object
  • Object
show all
Defined in:
lib/kabustation_client/models/orders_success.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrdersSuccess

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/kabustation_client/models/orders_success.rb', line 148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'details')
    if (value = attributes[:'details']).is_a?(Array)
      self.details = value
    end
  end
end

Instance Attribute Details

#account_type ⇒ Object

口座種別 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>2</td> <td>一般</td> </tr> <tr> <td>4</td> <td>特定</td> </tr> <tr> <td>12</td> <td>法人</td> </tr> </tbody> </table>



64
65
66
 
# File 'lib/kabustation_client/models/orders_success.rb', line 64

def 
  @account_type
end

#cash_margin ⇒ Object

取引区分 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>2</td> <td>新規</td> </tr> <tr> <td>3</td> <td>返済</td> </tr> </tbody> </table>



61
62
63
 
# File 'lib/kabustation_client/models/orders_success.rb', line 61

def cash_margin
  @cash_margin
end

#cum_qty ⇒ Object

約定数量



55
56
57
 
# File 'lib/kabustation_client/models/orders_success.rb', line 55

def cum_qty
  @cum_qty
end

#deliv_type ⇒ Object

受渡区分 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>2</td> <td>お預り金</td> </tr> <tr> <td>3</td> <td>auマネーコネクト</td> </tr> </tbody> </table>



67
68
69
 
# File 'lib/kabustation_client/models/orders_success.rb', line 67

def deliv_type
  @deliv_type
end

#details ⇒ Object

注文詳細



79
80
81
 
# File 'lib/kabustation_client/models/orders_success.rb', line 79

def details
  @details
end

#exchange ⇒ Object

市場コード <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>東証</td> </tr> <tr> <td>3</td> <td>名証</td> </tr> <tr> <td>5</td> <td>福証</td> </tr> <tr> <td>6</td> <td>札証</td> </tr> <tr> <td>9</td> <td>SOR</td> </tr> <tr> <td>2</td> <td>日通し</td> </tr> <tr> <td>23</td> <td>日中</td> </tr> <tr> <td>24</td> <td>夜間</td> </tr> </tbody> </table>



40
41
42
 
# File 'lib/kabustation_client/models/orders_success.rb', line 40

def exchange
  @exchange
end

#exchange_name ⇒ Object

市場名



43
44
45
 
# File 'lib/kabustation_client/models/orders_success.rb', line 43

def exchange_name
  @exchange_name
end

#expire_day ⇒ Object

注文有効期限
yyyyMMdd形式



70
71
72
 
# File 'lib/kabustation_client/models/orders_success.rb', line 70

def expire_day
  @expire_day
end

#id ⇒ Object

注文番号



19
20
21
 
# File 'lib/kabustation_client/models/orders_success.rb', line 19

def id
  @id
end

#margin_premium ⇒ Object

プレミアム料
※（注文中数量＋約定済数量）×１株あたりプレミアム料として計算されます。
※信用を注文した際に表示されます。
※制度信用売/買、一般（長期）買、一般（デイトレ）買の場合は、Noneと返されます。
一般（長期）売、一般（デイトレ）売の場合は、プレミアム料=0の場合、0（ゼロ）と返されます。



76
77
78
 
# File 'lib/kabustation_client/models/orders_success.rb', line 76

def margin_premium
  @margin_premium
end

#margin_trade_type ⇒ Object

信用取引区分
※信用を注文した際に表示されます。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>制度信用</td> </tr> <tr> <td>2</td> <td>一般信用（長期）</td> </tr> <tr> <td>3</td> <td>一般信用（デイトレ）</td> </tr> </tbody> </table>



73
74
75
 
# File 'lib/kabustation_client/models/orders_success.rb', line 73

def margin_trade_type
  @margin_trade_type
end

#ord_type ⇒ Object

執行条件 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>ザラバ</td> </tr> <tr> <td>2</td> <td>寄り</td> </tr> <tr> <td>3</td> <td>引け</td> </tr> <tr> <td>4</td> <td>不成</td> </tr> <tr> <td>5</td> <td>対当指値</td> </tr> <tr> <td>6</td> <td>IOC</td> </tr> </tbody> </table>



28
29
30
 
# File 'lib/kabustation_client/models/orders_success.rb', line 28

def ord_type
  @ord_type
end

#order_qty ⇒ Object

発注数量
※注文期限切れと失効の場合、OrderQtyはゼロになりません。
※期限切れと失効の確認方法としては、DetailsのRecType（3: 期限切れ、7: 失効）にてご確認ください。



52
53
54
 
# File 'lib/kabustation_client/models/orders_success.rb', line 52

def order_qty
  @order_qty
end

#order_state ⇒ Object

注文状態
※Stateと同一である <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>待機（発注待機）</td> </tr> <tr> <td>2</td> <td>処理中（発注送信中）</td> </tr> <tr> <td>3</td> <td>処理済（発注済・訂正済）</td> </tr> <tr> <td>4</td> <td>訂正取消送信中</td> </tr> <tr> <td>5</td> <td>終了（発注エラー・取消済・全約定・失効・期限切れ）</td> </tr> </tbody> </table>



25
26
27
 
# File 'lib/kabustation_client/models/orders_success.rb', line 25

def order_state
  @order_state
end

#price ⇒ Object

値段



49
50
51
 
# File 'lib/kabustation_client/models/orders_success.rb', line 49

def price
  @price
end

#recv_time ⇒ Object

受注日時



31
32
33
 
# File 'lib/kabustation_client/models/orders_success.rb', line 31

def recv_time
  @recv_time
end

#side ⇒ Object

売買区分 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>売</td> </tr> <tr> <td>2</td> <td>買</td> </tr> </tbody> </table>



58
59
60
 
# File 'lib/kabustation_client/models/orders_success.rb', line 58

def side
  @side
end

#state ⇒ Object

状態
※OrderStateと同一である <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>待機（発注待機）</td> </tr> <tr> <td>2</td> <td>処理中（発注送信中）</td> </tr> <tr> <td>3</td> <td>処理済（発注済・訂正済）</td> </tr> <tr> <td>4</td> <td>訂正取消送信中</td> </tr> <tr> <td>5</td> <td>終了（発注エラー・取消済・全約定・失効・期限切れ）</td> </tr> </tbody> </table>



22
23
24
 
# File 'lib/kabustation_client/models/orders_success.rb', line 22

def state
  @state
end

#symbol ⇒ Object

銘柄コード



34
35
36
 
# File 'lib/kabustation_client/models/orders_success.rb', line 34

def symbol
  @symbol
end

#symbol_name ⇒ Object

銘柄名



37
38
39
 
# File 'lib/kabustation_client/models/orders_success.rb', line 37

def symbol_name
  @symbol_name
end

#time_in_force ⇒ Object

有効期間条件
※先物・オプション銘柄の場合のみ <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>FAS</td> </tr> <tr> <td>2</td> <td>FAK</td> </tr> <tr> <td>3</td> <td>FOK</td> </tr> </tbody> </table>



46
47
48
 
# File 'lib/kabustation_client/models/orders_success.rb', line 46

def time_in_force
  @time_in_force
end

Class Method Details

._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



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
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/kabustation_client/models/orders_success.rb', line 330

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = KabustationClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



109
110
111
 
# File 'lib/kabustation_client/models/orders_success.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/kabustation_client/models/orders_success.rb', line 82

def self.attribute_map
  {
    :'id' => :'ID',
    :'state' => :'State',
    :'order_state' => :'OrderState',
    :'ord_type' => :'OrdType',
    :'recv_time' => :'RecvTime',
    :'symbol' => :'Symbol',
    :'symbol_name' => :'SymbolName',
    :'exchange' => :'Exchange',
    :'exchange_name' => :'ExchangeName',
    :'time_in_force' => :'TimeInForce',
    :'price' => :'Price',
    :'order_qty' => :'OrderQty',
    :'cum_qty' => :'CumQty',
    :'side' => :'Side',
    :'cash_margin' => :'CashMargin',
    :'account_type' => :'AccountType',
    :'deliv_type' => :'DelivType',
    :'expire_day' => :'ExpireDay',
    :'margin_trade_type' => :'MarginTradeType',
    :'margin_premium' => :'MarginPremium',
    :'details' => :'Details'
  }
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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/kabustation_client/models/orders_success.rb', line 306

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
 
# File 'lib/kabustation_client/models/orders_success.rb', line 141

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/kabustation_client/models/orders_success.rb', line 114

def self.openapi_types
  {
    :'id' => :'String',
    :'state' => :'Integer',
    :'order_state' => :'Integer',
    :'ord_type' => :'Integer',
    :'recv_time' => :'String',
    :'symbol' => :'String',
    :'symbol_name' => :'String',
    :'exchange' => :'Integer',
    :'exchange_name' => :'String',
    :'time_in_force' => :'Integer',
    :'price' => :'Float',
    :'order_qty' => :'Float',
    :'cum_qty' => :'Float',
    :'side' => :'String',
    :'cash_margin' => :'Integer',
    :'account_type' => :'Integer',
    :'deliv_type' => :'Integer',
    :'expire_day' => :'Integer',
    :'margin_trade_type' => :'Integer',
    :'margin_premium' => :'Float',
    :'details' => :'Array<OrdersSuccessDetailsInner>'
  }
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
283
284
285
286
287
288
289
 
# File 'lib/kabustation_client/models/orders_success.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      order_state == o.order_state &&
      ord_type == o.ord_type &&
      recv_time == o.recv_time &&
      symbol == o.symbol &&
      symbol_name == o.symbol_name &&
      exchange == o.exchange &&
      exchange_name == o.exchange_name &&
      time_in_force == o.time_in_force &&
      price == o.price &&
      order_qty == o.order_qty &&
      cum_qty == o.cum_qty &&
      side == o.side &&
      cash_margin == o.cash_margin &&
       == o. &&
      deliv_type == o.deliv_type &&
      expire_day == o.expire_day &&
      margin_trade_type == o.margin_trade_type &&
      margin_premium == o.margin_premium &&
      details == o.details
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



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/kabustation_client/models/orders_success.rb', line 401

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


293
294
295
 
# File 'lib/kabustation_client/models/orders_success.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/kabustation_client/models/orders_success.rb', line 299

def hash
  [id, state, order_state, ord_type, recv_time, symbol, symbol_name, exchange, exchange_name, time_in_force, price, order_qty, cum_qty, side, cash_margin, , deliv_type, expire_day, margin_trade_type, margin_premium, details].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



250
251
252
253
254
 
# File 'lib/kabustation_client/models/orders_success.rb', line 250

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



377
378
379
 
# File 'lib/kabustation_client/models/orders_success.rb', line 377

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



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

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



371
372
373
 
# File 'lib/kabustation_client/models/orders_success.rb', line 371

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



258
259
260
261
 
# File 'lib/kabustation_client/models/orders_success.rb', line 258

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end