Class: KabustationClient::OrdersSuccessDetailsInner

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrdersSuccessDetailsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#commissionObject

手数料
※注文詳細の明細種別が約定(RecType=8)の場合に設定。



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

def commission
  @commission
end

#commission_taxObject

手数料消費税
※明細種別は約定(RecType=8)の場合にのみ表示されます。



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

def commission_tax
  @commission_tax
end

#deliv_dayObject

受渡日



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

def deliv_day
  @deliv_day
end

#exchange_idObject

取引所番号



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

def exchange_id
  @exchange_id
end

#execution_dayObject

約定日時



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

def execution_day
  @execution_day
end

#execution_idObject

約定番号



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

def execution_id
  @execution_id
end

#idObject

注文詳細番号



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

def id
  @id
end

#ord_typeObject

執行条件 <table> <thead> <tr> <th>定義値</th> <th>説明</th> </tr> </thead> <tbody> <tr> <td>null</td> <td>RecType= 取消 の場合</td> </tr> <tr> <td>0</td> <td>RecType= 期限切れ, [7] 失効, [8] 約定 の場合</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>IOC</td> </tr> </tbody> </table>



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

def ord_type
  @ord_type
end

#priceObject

値段



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

def price
  @price
end

#qtyObject

数量



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

def qty
  @qty
end

#rec_typeObject

明細種別 <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>取消</td> </tr> <tr> <td>7</td> <td>失効</td> </tr> <tr> <td>8</td> <td>約定</td> </tr> </tbody> </table>



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

def rec_type
  @rec_type
end

#seq_numObject

※注文明細レコードの生成順序です。
※通番であるとは限りませんが、大小による順序は保たれています。



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

def seq_num
  @seq_num
end

#stateObject

状態 <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>



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

def state
  @state
end

#transact_timeObject

処理時刻



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

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



258
259
260
261
262
263
264
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
290
291
292
293
294
295
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 258

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_attributesObject

Returns all the JSON keys this model knows about



81
82
83
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 61

def self.attribute_map
  {
    :'seq_num' => :'SeqNum',
    :'id' => :'ID',
    :'rec_type' => :'RecType',
    :'exchange_id' => :'ExchangeID',
    :'state' => :'State',
    :'transact_time' => :'TransactTime',
    :'ord_type' => :'OrdType',
    :'price' => :'Price',
    :'qty' => :'Qty',
    :'execution_id' => :'ExecutionID',
    :'execution_day' => :'ExecutionDay',
    :'deliv_day' => :'DelivDay',
    :'commission' => :'Commission',
    :'commission_tax' => :'CommissionTax'
  }
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 234

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_nullableObject

List of attributes with nullable: true



106
107
108
109
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 106

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

.openapi_typesObject

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 86

def self.openapi_types
  {
    :'seq_num' => :'Integer',
    :'id' => :'String',
    :'rec_type' => :'Integer',
    :'exchange_id' => :'String',
    :'state' => :'Integer',
    :'transact_time' => :'String',
    :'ord_type' => :'Integer',
    :'price' => :'Float',
    :'qty' => :'Float',
    :'execution_id' => :'String',
    :'execution_day' => :'Time',
    :'deliv_day' => :'Integer',
    :'commission' => :'Float',
    :'commission_tax' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seq_num == o.seq_num &&
      id == o.id &&
      rec_type == o.rec_type &&
      exchange_id == o.exchange_id &&
      state == o.state &&
      transact_time == o.transact_time &&
      ord_type == o.ord_type &&
      price == o.price &&
      qty == o.qty &&
      execution_id == o.execution_id &&
      execution_day == o.execution_day &&
      deliv_day == o.deliv_day &&
      commission == o.commission &&
      commission_tax == o.commission_tax
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



329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 329

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


221
222
223
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 221

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



227
228
229
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 227

def hash
  [seq_num, id, rec_type, exchange_id, state, transact_time, ord_type, price, qty, execution_id, execution_day, deliv_day, commission, commission_tax].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



185
186
187
188
189
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 185

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



305
306
307
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 305

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 311

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

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



193
194
195
196
# File 'lib/kabustation_client/models/orders_success_details_inner.rb', line 193

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