Class: KabustationClient::RequestSendOrderDerivOption

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestSendOrderDerivOption

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'trade_type')
    self.trade_type = attributes[:'trade_type']
  else
    self.trade_type = nil
  end

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

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

  if attributes.key?(:'qty')
    self.qty = attributes[:'qty']
  else
    self.qty = nil
  end

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

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

  if attributes.key?(:'front_order_type')
    self.front_order_type = attributes[:'front_order_type']
  else
    self.front_order_type = nil
  end

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

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

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

Instance Attribute Details

#close_position_order ⇒ Object

決済順序
※ClosePositionOrderとClosePositionsはどちらか一方のみ指定可能。
※ClosePositionOrderとClosePositionsを両方指定した場合、エラー。 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>0</td> <td>日付（古い順）、損益（高い順）</td> </tr> <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>損益（低い順）、日付（古い順）</td> </tr> <tr> <td>7</td> <td>損益（低い順）、日付（新しい順）</td> </tr> </tbody> </table>



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

def close_position_order
  @close_position_order
end

#close_positions ⇒ Object

返済建玉指定
※ClosePositionOrderとClosePositionsはどちらか一方のみ指定可能。
※ClosePositionOrderとClosePositionsを両方指定した場合、エラー。



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

def close_positions
  @close_positions
end

#exchange ⇒ Object

市場コード <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>2</td> <td>日通し</td> </tr> <tr> <td>23</td> <td>日中</td> </tr> <tr> <td>24</td> <td>夜間</td> </tr> </tbody> </table>



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

def exchange
  @exchange
end

#expire_day ⇒ Object

注文有効期限
yyyyMMdd形式。
「0」を指定すると、kabuステーション上の発注画面の「本日」に対応する日付として扱います。
「本日」は直近の注文可能日となり、以下のように設定されます。
その市場の引けまでの間 : 当日
その市場の引け後 : 翌取引所営業日
その市場の休前日 : 休日明けの取引所営業日
※ 日替わりはkabuステーションが日付変更通知を受信したタイミングです。
※ 日通しの場合、夜間取引の引け後に日付が更新されます。



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

def expire_day
  @expire_day
end

#front_order_type ⇒ Object

執行条件 <table> <thead> <tr> <th>定義値</th> <th>説明</th> <th>”Price”の指定</th> </tr> </thead> <tbody> <tr> <td>18</td> <td>引成（派生）
※TimeInForceは、「FAK」のみ有効</td> <td>0</td> </tr> <tr> <td>20</td> <td>指値</td> <td>発注したい金額</td> </tr> <tr> <td>28</td> <td>引指（派生）
※TimeInForceは、「FAS」のみ有効</td> <td>発注したい金額</td> </tr> <tr> <td>30</td> <td>逆指値</td> <td>指定なし
※AfterHitPriceで指定ください</td> </tr> <tr> <td>120</td> <td>成行（マーケットオーダー）</td> <td>0</td> </tr> </tbody> </table>



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

def front_order_type
  @front_order_type
end

#password ⇒ Object

注文パスワード



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

def password
  @password
end

#price ⇒ Object

注文価格
※FrontOrderTypeで成行を指定した場合、0を指定する。
※詳細について、”FrontOrderType”をご確認ください。



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

def price
  @price
end

#qty ⇒ Object

注文数量



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

def qty
  @qty
end

#reverse_limit_order ⇒ Object

Returns the value of attribute reverse_limit_order.



54
55
56
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 54

def reverse_limit_order
  @reverse_limit_order
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>



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

def side
  @side
end

#symbol ⇒ Object

銘柄コード
※取引最終日に「オプション銘柄コード取得」でDerivMonthに0（直近限月）を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。



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

def symbol
  @symbol
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> ※執行条件(FrontOrderType)、有効期限条件(TimeInForce)、市場コード(Exchange)で選択できる組み合わせは下表のようになります。 <table> <thead> <tr> <th rowspan="2">執行条件</th> <th rowspan="2">有効期間条件</th> <th colspan="3">市場コード</th> </tr> <tr> <th>日中</th> <th>夜間</th> <th>日通し</th> </tr> </thead> <tbody> <tr> <td>指値</td> <td>FAS</td> <td>●</td> <td>●</td> <td>●</td> </tr> <tr> <td>指値</td> <td>FAK</td> <td>●</td> <td>●</td> <td>-</td> </tr> <tr> <td>指値</td> <td>FOK</td> <td>●</td> <td>●</td> <td>-</td> </tr> <tr> <td>成行</td> <td>FAK</td> <td>●</td> <td>●</td> <td>-</td> </tr> <tr> <td>成行</td> <td>FOK</td> <td>●</td> <td>●</td> <td>-</td> </tr> <tr> <td>逆指値（指値）</td> <td>FAK</td> <td>●</td> <td>●</td> <td>●</td> </tr> <tr> <td>逆指値（成行）</td> <td>FAK</td> <td>●</td> <td>●</td> <td>-</td> </tr> <tr> <td>引成</td> <td>FAK</td> <td>●</td> <td>●</td> <td>-</td> </tr> <tr> <td>引指</td> <td>FAS</td> <td>●</td> <td>●</td> <td>-</td> </tr> </tbody> </table>



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

def time_in_force
  @time_in_force
end

#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> </tbody> </table>



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

def trade_type
  @trade_type
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



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
356
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 319

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 57

def self.attribute_map
  {
    :'password' => :'Password',
    :'symbol' => :'Symbol',
    :'exchange' => :'Exchange',
    :'trade_type' => :'TradeType',
    :'time_in_force' => :'TimeInForce',
    :'side' => :'Side',
    :'qty' => :'Qty',
    :'close_position_order' => :'ClosePositionOrder',
    :'close_positions' => :'ClosePositions',
    :'front_order_type' => :'FrontOrderType',
    :'price' => :'Price',
    :'expire_day' => :'ExpireDay',
    :'reverse_limit_order' => :'ReverseLimitOrder'
  }
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 295

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



100
101
102
103
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 81

def self.openapi_types
  {
    :'password' => :'String',
    :'symbol' => :'String',
    :'exchange' => :'Integer',
    :'trade_type' => :'Integer',
    :'time_in_force' => :'Integer',
    :'side' => :'String',
    :'qty' => :'Integer',
    :'close_position_order' => :'Integer',
    :'close_positions' => :'Array<PositionsDeriv>',
    :'front_order_type' => :'Integer',
    :'price' => :'Float',
    :'expire_day' => :'Integer',
    :'reverse_limit_order' => :'RequestSendOrderDerivFutureReverseLimitOrder'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      password == o.password &&
      symbol == o.symbol &&
      exchange == o.exchange &&
      trade_type == o.trade_type &&
      time_in_force == o.time_in_force &&
      side == o.side &&
      qty == o.qty &&
      close_position_order == o.close_position_order &&
      close_positions == o.close_positions &&
      front_order_type == o.front_order_type &&
      price == o.price &&
      expire_day == o.expire_day &&
      reverse_limit_order == o.reverse_limit_order
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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 390

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


282
283
284
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



288
289
290
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 288

def hash
  [password, symbol, exchange, trade_type, time_in_force, side, qty, close_position_order, close_positions, front_order_type, price, expire_day, reverse_limit_order].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @password.nil?
    invalid_properties.push('invalid value for "password", password cannot be nil.')
  end

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

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

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

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

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

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

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

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

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



366
367
368
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 366

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 372

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



360
361
362
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 360

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/kabustation_client/models/request_send_order_deriv_option.rb', line 245

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @password.nil?
  return false if @symbol.nil?
  return false if @exchange.nil?
  return false if @trade_type.nil?
  return false if @time_in_force.nil?
  return false if @side.nil?
  return false if @qty.nil?
  return false if @front_order_type.nil?
  return false if @price.nil?
  return false if @expire_day.nil?
  true
end