kabustation_client 1.0.0

data/lib/kabustation_client/models/request_send_order_deriv_future.rb

@@ -0,0 +1,406 @@
+=begin
+#kabuステーションAPI
+
+## 定義情報   REST APIのコード一覧、エンドポイントは下記リンク参照     - [REST APIコード一覧](../ptal/error.html)
+
+The version of the OpenAPI document: 1.5
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KabustationClient
+  class RequestSendOrderDerivFuture
+    # 注文パスワード
+    attr_accessor :password
+
+    # 銘柄コード<br>※取引最終日に「先物銘柄コード取得」でDerivMonthに0（直近限月）を指定した場合、日中・夜間の時間帯に関わらず、取引最終日を迎える限月の銘柄コードを返します。取引最終日を迎える銘柄の取引は日中取引をもって終了となりますので、ご注意ください。
+    attr_accessor :symbol
+
+    # 市場コード <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> <tr> <td>32</td> <td>SOR日通し</td> </tr> <tr> <td>33</td> <td>SOR日中</td> </tr> <tr> <td>34</td> <td>SOR夜間</td> </tr> </tbody> </table> SOR日中、SOR夜間、SOR日通しは一部銘柄のみ対象となります。<br> SOR対象銘柄は以下をご参照ください。 <table> <thead> <tr> <th>先物SOR取扱銘柄</th> <th>有効限月</th> </tr> </thead> <tbody> <tr> <td>日経225先物ラージ</td> <td>直近2限月</td> </tr> <tr> <td>日経225先物ミニ</td> <td>直近4限月</td> </tr> <tr> <td>TOPIX先物ラージ</td> <td>直近2限月</td> </tr> <tr> <td>TOPIX先物ミニ </td> <td>直近3限月</td> </tr> <tr> <td>東証マザーズ指数先物</td> <td>直近2限月</td> </tr> <tr> <td>JPX日経400先物</td> <td>直近2限月</td> </tr> <tr> <td>NYダウ先物</td> <td>直近2限月</td> </tr> </tbody> </table>
+    attr_accessor :exchange
+
+    # 取引区分 <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>
+    attr_accessor :trade_type
+
+    # 有効期間条件 <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)で選択できる組み合わせは下表のようになります。<br>  <br>■日中、夜間、日通し対応表           <table>   <thead>     <tr>       <th rowspan=\"2\">執行条件</th>       <th rowspan=\"2\">有効<br>期間条件</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>  <br>■SOR日中、SOR夜間、SOR日通し対応表   <table>   <thead>     <tr>       <th rowspan=\"2\">執行条件</th>       <th rowspan=\"2\">有効<br>期間条件</th>       <th colspan=\"3\">市場コード</th>     </tr>     <tr>       <th>SOR日中</th>       <th>SOR夜間</th>       <th>SOR日通し</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>
+    attr_accessor :time_in_force
+
+    # 売買区分 <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>
+    attr_accessor :side
+
+    # 注文数量
+    attr_accessor :qty
+
+    # 決済順序<br>※ClosePositionOrderとClosePositionsはどちらか一方のみ指定可能。<br>※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>
+    attr_accessor :close_position_order
+
+    # 返済建玉指定<br>※ClosePositionOrderとClosePositionsはどちらか一方のみ指定可能。<br>※ClosePositionOrderとClosePositionsを両方指定した場合、エラー。
+    attr_accessor :close_positions
+
+    # 執行条件 <table>   <thead>       <tr>           <th>定義値</th>           <th>説明</th>           <th>”Price”の指定</th>       </tr>   </thead>   <tbody>       <tr>           <td>18</td>           <td>引成（派生）<br>※TimeInForceは、「FAK」のみ有効</td>           <td>0</td>       </tr>       <tr>           <td>20</td>           <td>指値</td>           <td>発注したい金額</td>       </tr>       <tr>           <td>28</td>           <td>引指（派生）<br>※TimeInForceは、「FAS」のみ有効</td>           <td>発注したい金額</td>       </tr>       <tr>           <td>30</td>           <td>逆指値</td>           <td>指定なし<br>※AfterHitPriceで指定ください</td>       </tr>       <tr>           <td>120</td>           <td>成行（マーケットオーダー）</td>           <td>0</td>       </tr>   </tbody> </table>
+    attr_accessor :front_order_type
+
+    # 注文価格<br>※FrontOrderTypeで成行を指定した場合、0を指定する。<br>※詳細について、”FrontOrderType”をご確認ください。
+    attr_accessor :price
+
+    # 注文有効期限<br> yyyyMMdd形式。<br> 「0」を指定すると、kabuステーション上の発注画面の「本日」に対応する日付として扱います。<br> 「本日」は直近の注文可能日となり、以下のように設定されます。<br> その市場の引けまでの間 : 当日<br> その市場の引け後       : 翌取引所営業日<br> その市場の休前日       : 休日明けの取引所営業日<br> ※ 日替わりはkabuステーションが日付変更通知を受信したタイミングです。<br> ※ 日通しの場合、夜間取引の引け後に日付が更新されます。
+    attr_accessor :expire_day
+
+    attr_accessor :reverse_limit_order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    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
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    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
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `KabustationClient::RequestSendOrderDerivFuture` 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::RequestSendOrderDerivFuture`. 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
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    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
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    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
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    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
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+
+end