snaptrade 2.0.162 → 2.0.163

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d0b0cc8be4545206c323ad3a5c5f12b3d554b2e68cb9c0d824f8c9e487916e
-  data.tar.gz: 0203e68a5490b53f71c06b8b9a67a25131676c25907e8f702e65bc42be947e08
+  metadata.gz: b0d0339193f49eb4054b1acc4117f5d3908eeac1216d70285623c61902b7d8c5
+  data.tar.gz: 518944dd0e7fe9ab5f1aad96792e7a502cba9bcbb8588371f361f7249cfa85de
 SHA512:
-  metadata.gz: 77e7ad45a7b99c316d50f4c680ac78a94ef4102b26792c891d572e6b2c75eefde3595fa186c41e322cdc4f73e3b73cb1c0d28972ac169f9abe591b851d199807
-  data.tar.gz: 1b1c02c6fd99c6ff4d2d12963ede139f399420d1a244842080044e8f2c07eb86e3f01bb66faa559c939d6f24af870dfc6012acc785a9dba8c87661b545253593
+  metadata.gz: 27aff07e9e57db3b29bdd26e695b7ac801959edf7b1df0af3a8aa06962746d321bbe42c65f3dad38c0ca8225d4331820812aa987185a64df3b1331939512eae7
+  data.tar.gz: ca89c95353f8a4f9ab22910539a4a048e516e3c47360b75d4bcee4c53bd15bbc7509928397263abc33347e9a38e28ed539aec590cc22c22f6dac112136aec3fb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.162)
+    snaptrade (2.0.163)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -29,7 +29,7 @@ GEM
     method_source (1.1.0)
     multipart-post (2.4.1)
     parallel (1.27.0)
-    parser (3.3.10.1)
+    parser (3.3.10.2)
       ast (~> 2.4.1)
       racc
     prism (1.9.0)

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.162-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.162)
+[![npm](https://img.shields.io/badge/gem-v2.0.163-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.163)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -64,6 +64,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.trading.cancel_order`](#snaptradetradingcancel_order)
   * [`snaptrade.trading.cancel_user_account_order`](#snaptradetradingcancel_user_account_order)
   * [`snaptrade.trading.get_cryptocurrency_pair_quote`](#snaptradetradingget_cryptocurrency_pair_quote)
+  * [`snaptrade.trading.get_option_impact`](#snaptradetradingget_option_impact)
   * [`snaptrade.trading.get_order_impact`](#snaptradetradingget_order_impact)
   * [`snaptrade.trading.get_user_account_quotes`](#snaptradetradingget_user_account_quotes)
   * [`snaptrade.trading.place_bracket_order`](#snaptradetradingplace_bracket_order)
@@ -84,7 +85,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.162'
+gem 'snaptrade', '~> 2.0.163'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1797,6 +1798,77 @@ p result
 ---
 
 
+### `snaptrade.trading.get_option_impact`<a id="snaptradetradingget_option_impact"></a>
+
+Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
+Only supported for certain brokerages. Please refer to https://snaptrade.notion.site/brokerages for more information on brokerage trading support.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.trading.get_option_impact(
+  order_type: "MARKET",
+  time_in_force: "Day",
+  legs: [
+        {
+            "instrument" => {
+                "symbol" => "PBI   250718C00006000",
+                "instrument_type" => "OPTION",
+            },
+            "action" => "BUY_TO_OPEN",
+            "units" => 1,
+        }
+    ],
+  user_id: "snaptrade-user-123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+  limit_price: "",
+  stop_price: "",
+  price_effect: "DEBIT",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### order_type: [`MlegOrderTypeStrict`](./lib/snaptrade/models/mleg_order_type_strict.rb)<a id="order_type-mlegordertypestrictlibsnaptrademodelsmleg_order_type_strictrb"></a>
+The type of order to place.
+
+##### time_in_force: [`TimeInForceStrict`](./lib/snaptrade/models/time_in_force_strict.rb)<a id="time_in_force-timeinforcestrictlibsnaptrademodelstime_in_force_strictrb"></a>
+The Time in Force type for the order. This field indicates how long the order
+will remain active before it is executed or expires. Here are the supported
+values: - `Day` - Day. The order is valid only for the trading day on which it
+is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed
+or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety
+immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order
+must be executed immediately. Any portion of the order that cannot be filled
+immediately will be canceled.
+
+##### legs: Array<[`MlegLeg`](./lib/snaptrade/models/mleg_leg.rb)><a id="legs-array"></a>
+##### user_id: `String`<a id="user_id-string"></a>
+##### user_secret: `String`<a id="user_secret-string"></a>
+##### account_id: `String`<a id="account_id-string"></a>
+##### limit_price: `Float`<a id="limit_price-float"></a>
+The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
+
+##### stop_price: `Float`<a id="stop_price-float"></a>
+The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+
+##### price_effect: [`MlegPriceEffectStrict`](./lib/snaptrade/models/mleg_price_effect_strict.rb)<a id="price_effect-mlegpriceeffectstrictlibsnaptrademodelsmleg_price_effect_strictrb"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[OptionImpact](./lib/snaptrade/models/option_impact.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/trading/options/impact` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.trading.get_order_impact`<a id="snaptradetradingget_order_impact"></a>
 
 Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.

data/lib/snaptrade/api/trading_api.rb

@@ -378,6 +378,152 @@ module SnapTrade
     end
 
 
+    # Get option order impact
+    #
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
+    # Only supported for certain brokerages. Please refer to https://snaptrade.notion.site/brokerages for more information on brokerage trading support.
+    #
+    # @param order_type [MlegOrderTypeStrict] The type of order to place.
+    # @param time_in_force [TimeInForceStrict] The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. 
+    # @param legs [Array<MlegLeg>] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
+    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    # @param price_effect [MlegPriceEffectStrict] 
+    # @param body [MlegTradeForm] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_option_impact(order_type:, time_in_force:, legs:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, price_effect: SENTINEL, extra: {})
+      _body = {}
+      _body[:order_type] = order_type if order_type != SENTINEL
+      _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
+      _body[:limit_price] = limit_price if limit_price != SENTINEL
+      _body[:stop_price] = stop_price if stop_price != SENTINEL
+      _body[:price_effect] = price_effect if price_effect != SENTINEL
+      _body[:legs] = legs if legs != SENTINEL
+      mleg_trade_form = _body
+      data, _status_code, _headers = get_option_impact_with_http_info_impl(user_id, user_secret, account_id, mleg_trade_form, extra)
+      data
+    end
+
+    # Get option order impact
+    #
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
+    # Only supported for certain brokerages. Please refer to https://snaptrade.notion.site/brokerages for more information on brokerage trading support.
+    #
+    # @param order_type [MlegOrderTypeStrict] The type of order to place.
+    # @param time_in_force [TimeInForceStrict] The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. 
+    # @param legs [Array<MlegLeg>] 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param limit_price [Float] The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
+    # @param stop_price [Float] The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    # @param price_effect [MlegPriceEffectStrict] 
+    # @param body [MlegTradeForm] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_option_impact_with_http_info(order_type:, time_in_force:, legs:, user_id:, user_secret:, account_id:, limit_price: SENTINEL, stop_price: SENTINEL, price_effect: SENTINEL, extra: {})
+      _body = {}
+      _body[:order_type] = order_type if order_type != SENTINEL
+      _body[:time_in_force] = time_in_force if time_in_force != SENTINEL
+      _body[:limit_price] = limit_price if limit_price != SENTINEL
+      _body[:stop_price] = stop_price if stop_price != SENTINEL
+      _body[:price_effect] = price_effect if price_effect != SENTINEL
+      _body[:legs] = legs if legs != SENTINEL
+      mleg_trade_form = _body
+      get_option_impact_with_http_info_impl(user_id, user_secret, account_id, mleg_trade_form, extra)
+    end
+
+    # Get option order impact
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://snaptrade.notion.site/brokerages for more information on brokerage trading support. 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param mleg_trade_form [MlegTradeForm] 
+    # @param [Hash] opts the optional parameters
+    # @return [OptionImpact]
+    private def get_option_impact_impl(user_id, user_secret, account_id, mleg_trade_form, opts = {})
+      data, _status_code, _headers = get_option_impact_with_http_info(user_id, user_secret, account_id, mleg_trade_form, opts)
+      data
+    end
+
+    # Get option order impact
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://snaptrade.notion.site/brokerages for more information on brokerage trading support. 
+    # @param user_id [String] 
+    # @param user_secret [String] 
+    # @param account_id [String] 
+    # @param mleg_trade_form [MlegTradeForm] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OptionImpact, Integer, Hash)>] OptionImpact data, response status code and response headers
+    private def get_option_impact_with_http_info_impl(user_id, user_secret, account_id, mleg_trade_form, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TradingApi.get_option_impact ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling TradingApi.get_option_impact"
+      end
+      # verify the required parameter 'user_secret' is set
+      if @api_client.config.client_side_validation && user_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'user_secret' when calling TradingApi.get_option_impact"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling TradingApi.get_option_impact"
+      end
+      # verify the required parameter 'mleg_trade_form' is set
+      if @api_client.config.client_side_validation && mleg_trade_form.nil?
+        fail ArgumentError, "Missing the required parameter 'mleg_trade_form' when calling TradingApi.get_option_impact"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/trading/options/impact'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'userId'] = user_id
+      query_params[:'userSecret'] = user_secret
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(mleg_trade_form)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OptionImpact'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"TradingApi.get_option_impact",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TradingApi#get_option_impact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # Check equity order impact
     #
     # Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.

data/lib/snaptrade/models/option_impact.rb

@@ -0,0 +1,228 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  # Estimated cost and fees for an option order before it is placed.
+  class OptionImpact
+    # Estimated option premium for the order (before fees).
+    attr_accessor :estimated_cost
+
+    # Estimated transaction fees and commissions for the order.
+    attr_accessor :estimated_transaction_fee
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'estimated_cost' => :'estimated_cost',
+        :'estimated_transaction_fee' => :'estimated_transaction_fee'
+      }
+    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
+      {
+        :'estimated_cost' => :'String',
+        :'estimated_transaction_fee' => :'String'
+      }
+    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 `SnapTrade::OptionImpact` 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 `SnapTrade::OptionImpact`. 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?(:'estimated_cost')
+        self.estimated_cost = attributes[:'estimated_cost']
+      end
+
+      if attributes.key?(:'estimated_transaction_fee')
+        self.estimated_transaction_fee = attributes[:'estimated_transaction_fee']
+      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
+      invalid_properties = Array.new
+      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?
+      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 &&
+          estimated_cost == o.estimated_cost &&
+          estimated_transaction_fee == o.estimated_transaction_fee
+    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
+      [estimated_cost, estimated_transaction_fee].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[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]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = SnapTrade.const_get(type)
+        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

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.162'
+  VERSION = '2.0.163'
 end

data/lib/snaptrade.rb

@@ -115,6 +115,7 @@ require 'snaptrade/models/option_brokerage_symbol'
 require 'snaptrade/models/option_chain_inner'
 require 'snaptrade/models/option_chain_inner_chain_per_root_inner'
 require 'snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner'
+require 'snaptrade/models/option_impact'
 require 'snaptrade/models/option_leg'
 require 'snaptrade/models/option_leg_action'
 require 'snaptrade/models/option_strategy'

data/spec/api/trading_api_spec.rb

@@ -72,6 +72,21 @@ describe 'TradingApi' do
     end
   end
 
+  # unit tests for get_option_impact
+  # Get option order impact
+  # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://snaptrade.notion.site/brokerages for more information on brokerage trading support. 
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id 
+  # @param mleg_trade_form 
+  # @param [Hash] opts the optional parameters
+  # @return [OptionImpact]
+  describe 'get_option_impact test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_order_impact
   # Check equity order impact
   # Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.

data/spec/models/option_impact_spec.rb

@@ -0,0 +1,35 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::OptionImpact
+describe SnapTrade::OptionImpact do
+  let(:instance) { SnapTrade::OptionImpact.new }
+
+  describe 'test an instance of OptionImpact' do
+    it 'should create an instance of OptionImpact' do
+      expect(instance).to be_instance_of(SnapTrade::OptionImpact)
+    end
+  end
+  describe 'test attribute "estimated_cost"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "estimated_transaction_fee"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.162
+  version: 2.0.163
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-02-14 00:00:00.000000000 Z
+date: 2026-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -195,6 +195,7 @@ files:
 - lib/snaptrade/models/option_chain_inner.rb
 - lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb
 - lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb
+- lib/snaptrade/models/option_impact.rb
 - lib/snaptrade/models/option_leg.rb
 - lib/snaptrade/models/option_leg_action.rb
 - lib/snaptrade/models/option_strategy.rb
@@ -371,6 +372,7 @@ files:
 - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
 - spec/models/option_chain_inner_chain_per_root_inner_spec.rb
 - spec/models/option_chain_inner_spec.rb
+- spec/models/option_impact_spec.rb
 - spec/models/option_leg_action_spec.rb
 - spec/models/option_leg_spec.rb
 - spec/models/option_strategy_legs_inner_spec.rb
@@ -462,177 +464,178 @@ specification_version: 4
 summary: SnapTrade Ruby Gem
 test_files:
 - spec/api/trading_api_spec.rb
-- spec/api/api_status_api_spec.rb
-- spec/api/reference_data_api_spec.rb
 - spec/api/options_api_spec.rb
-- spec/api/authentication_api_spec.rb
+- spec/api/api_status_api_spec.rb
 - spec/api/experimental_endpoints_api_spec.rb
-- spec/api/account_information_api_spec.rb
 - spec/api/connections_api_spec.rb
 - spec/api/transactions_and_reporting_api_spec.rb
+- spec/api/account_information_api_spec.rb
+- spec/api/reference_data_api_spec.rb
+- spec/api/authentication_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/getting_started_spec.rb
-- spec/models/balance_spec.rb
-- spec/models/symbol_currency_spec.rb
-- spec/models/snap_trade_holdings_account_spec.rb
-- spec/models/login_redirect_uri_spec.rb
-- spec/models/snap_trade_holdings_total_value_spec.rb
-- spec/models/universal_activity_spec.rb
-- spec/models/symbol_spec.rb
-- spec/models/manual_trade_balance_spec.rb
-- spec/models/encrypted_response_encrypted_message_data_spec.rb
-- spec/models/model500_unexpected_exception_response_spec.rb
-- spec/models/take_profit_spec.rb
-- spec/models/account_holdings_spec.rb
-- spec/models/holdings_status_spec.rb
-- spec/models/trading_instrument_type_spec.rb
-- spec/models/mleg_order_type_strict_spec.rb
-- spec/models/account_simple_spec.rb
-- spec/models/brokerage_spec.rb
-- spec/models/account_order_record_quote_universal_symbol_spec.rb
+- spec/models/options_symbol_spec.rb
+- spec/models/crypto_order_preview_estimated_fee_spec.rb
+- spec/models/net_dividend_spec.rb
+- spec/models/validated_trade_body_spec.rb
+- spec/models/strategy_quotes_greek_spec.rb
+- spec/models/connection_portal_version_spec.rb
+- spec/models/underlying_symbol_spec.rb
+- spec/models/monthly_dividends_spec.rb
+- spec/models/option_type_spec.rb
+- spec/models/account_balance_spec.rb
+- spec/models/underlying_symbol_exchange_spec.rb
+- spec/models/connection_type_spec.rb
+- spec/models/snap_trade_login_user_request_body_spec.rb
+- spec/models/rate_of_return_object_spec.rb
+- spec/models/performance_custom_spec.rb
+- spec/models/account_order_record_quote_currency_spec.rb
+- spec/models/option_leg_action_spec.rb
 - spec/models/simple_order_form_spec.rb
-- spec/models/partner_data_spec.rb
-- spec/models/manual_trade_symbol_spec.rb
-- spec/models/mleg_price_effect_strict_spec.rb
-- spec/models/strategy_order_record_status_spec.rb
+- spec/models/us_exchange_spec.rb
 - spec/models/balance_currency_spec.rb
-- spec/models/cancel_order_response_spec.rb
-- spec/models/symbol_figi_instrument_spec.rb
-- spec/models/account_orders_v2_response_spec.rb
-- spec/models/model401_failed_request_response_spec.rb
-- spec/models/rate_of_return_object_spec.rb
-- spec/models/manual_trade_spec.rb
-- spec/models/timeframe_spec.rb
-- spec/models/brokerage_authorization_spec.rb
-- spec/models/snap_trade_register_user_request_body_spec.rb
-- spec/models/action_strict_with_options_spec.rb
+- spec/models/account_universal_activity_spec.rb
+- spec/models/mleg_price_effect_strict_spec.rb
+- spec/models/crypto_order_preview_spec.rb
+- spec/models/manual_trade_form_with_options_spec.rb
+- spec/models/take_profit_spec.rb
+- spec/models/crypto_trading_instrument_spec.rb
 - spec/models/transactions_status_spec.rb
-- spec/models/account_order_record_leg_spec.rb
-- spec/models/encrypted_response_spec.rb
+- spec/models/manual_trade_and_impact_spec.rb
+- spec/models/underlying_symbol_type_spec.rb
 - spec/models/symbols_quotes_inner_spec.rb
-- spec/models/manual_trade_form_spec.rb
-- spec/models/option_leg_action_spec.rb
-- spec/models/cryptocurrency_pair_quote_spec.rb
-- spec/models/model404_failed_request_response_spec.rb
-- spec/models/mleg_trading_instrument_spec.rb
-- spec/models/options_position_spec.rb
-- spec/models/child_brokerage_order_ids_spec.rb
-- spec/models/manual_trade_replace_form_spec.rb
-- spec/models/manual_trade_impact_spec.rb
-- spec/models/net_dividend_spec.rb
-- spec/models/account_balance_spec.rb
-- spec/models/option_chain_inner_spec.rb
-- spec/models/monthly_dividends_spec.rb
-- spec/models/account_order_record_option_symbol_spec.rb
+- spec/models/symbol_exchange_spec.rb
+- spec/models/manual_trade_form_bracket_spec.rb
+- spec/models/snap_trade_holdings_total_value_spec.rb
 - spec/models/model402_brokerage_auth_disabled_response_spec.rb
-- spec/models/position_symbol_spec.rb
-- spec/models/account_universal_activity_spec.rb
-- spec/models/brokerage_instruments_response_spec.rb
-- spec/models/manual_trade_and_impact_spec.rb
-- spec/models/brokerage_authorization_type_read_only_spec.rb
-- spec/models/validated_trade_body_spec.rb
-- spec/models/account_order_record_leg_instrument_spec.rb
-- spec/models/universal_symbol_spec.rb
-- spec/models/account_order_record_quote_currency_spec.rb
+- spec/models/brokerage_authorization_disabled_confirmation_spec.rb
+- spec/models/brokerage_spec.rb
+- spec/models/manual_trade_symbol_spec.rb
+- spec/models/manual_trade_impact_spec.rb
+- spec/models/position_spec.rb
+- spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
+- spec/models/dividend_at_date_spec.rb
+- spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
 - spec/models/strategy_type_spec.rb
-- spec/models/options_position_currency_spec.rb
-- spec/models/currency_spec.rb
+- spec/models/stop_loss_spec.rb
+- spec/models/timeframe_spec.rb
+- spec/models/crypto_trading_instrument_type_spec.rb
+- spec/models/trading_instrument_spec.rb
+- spec/models/account_orders_v2_response_spec.rb
+- spec/models/order_updated_response_spec.rb
+- spec/models/partner_data_spec.rb
 - spec/models/sub_period_return_rate_spec.rb
-- spec/models/connections_session_events200_response_inner_spec.rb
-- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
-- spec/models/position_currency_spec.rb
+- spec/models/mleg_trading_instrument_spec.rb
 - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
-- spec/models/account_order_record_spec.rb
-- spec/models/strategy_quotes_greek_spec.rb
-- spec/models/net_contributions_spec.rb
-- spec/models/mleg_order_response_spec.rb
-- spec/models/manual_trade_form_notional_value_spec.rb
-- spec/models/account_universal_activity_option_symbol_spec.rb
-- spec/models/account_sync_status_spec.rb
-- spec/models/exchange_rate_pairs_spec.rb
-- spec/models/crypto_order_preview_estimated_fee_spec.rb
-- spec/models/account_order_record_status_v2_spec.rb
-- spec/models/crypto_order_preview_spec.rb
-- spec/models/snap_trade_login_user_request_body_spec.rb
-- spec/models/action_strict_spec.rb
-- spec/models/security_type_spec.rb
-- spec/models/cryptocurrency_pair_spec.rb
-- spec/models/account_order_record_universal_symbol_spec.rb
-- spec/models/trading_session_spec.rb
-- spec/models/order_type_strict_spec.rb
-- spec/models/brokerage_authorization_disabled_confirmation_spec.rb
-- spec/models/auth_type_spec.rb
+- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
+- spec/models/account_balance_total_spec.rb
+- spec/models/model400_failed_request_response_spec.rb
+- spec/models/figi_instrument_spec.rb
+- spec/models/manual_trade_replace_form_spec.rb
+- spec/models/recent_orders_response_spec.rb
+- spec/models/holdings_status_spec.rb
+- spec/models/account_spec.rb
+- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
+- spec/models/manual_trade_form_spec.rb
+- spec/models/connections_session_events200_response_inner_spec.rb
+- spec/models/model425_failed_request_response_spec.rb
+- spec/models/symbol_spec.rb
+- spec/models/strategy_order_record_status_spec.rb
+- spec/models/currency_spec.rb
+- spec/models/strategy_quotes_spec.rb
+- spec/models/snap_trade_holdings_account_spec.rb
+- spec/models/option_chain_inner_spec.rb
+- spec/models/exchange_spec.rb
+- spec/models/model404_failed_request_response_spec.rb
+- spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
 - spec/models/notional_value_spec.rb
 - spec/models/status_spec.rb
-- spec/models/option_type_spec.rb
-- spec/models/brokerage_type_spec.rb
-- spec/models/dividend_at_date_spec.rb
+- spec/models/universal_activity_spec.rb
+- spec/models/session_event_type_spec.rb
+- spec/models/mleg_leg_spec.rb
+- spec/models/account_order_record_status_v2_spec.rb
 - spec/models/brokerage_instrument_spec.rb
+- spec/models/account_sync_status_spec.rb
+- spec/models/simple_order_form_type_spec.rb
+- spec/models/past_value_spec.rb
+- spec/models/time_in_force_strict_spec.rb
+- spec/models/account_order_record_leg_spec.rb
+- spec/models/authentication_login_snap_trade_user200_response_spec.rb
+- spec/models/account_order_record_quote_universal_symbol_spec.rb
+- spec/models/symbol_figi_instrument_spec.rb
+- spec/models/brokerage_type_spec.rb
+- spec/models/mleg_order_type_strict_spec.rb
+- spec/models/manual_trade_balance_spec.rb
+- spec/models/account_order_record_universal_symbol_spec.rb
+- spec/models/account_holdings_account_spec.rb
+- spec/models/manual_trade_spec.rb
+- spec/models/brokerage_instruments_response_spec.rb
+- spec/models/options_position_spec.rb
+- spec/models/tax_lot_spec.rb
+- spec/models/account_order_record_option_symbol_spec.rb
 - spec/models/mleg_action_strict_spec.rb
+- spec/models/trading_instrument_type_spec.rb
+- spec/models/model401_failed_request_response_spec.rb
+- spec/models/mleg_order_response_spec.rb
+- spec/models/options_position_currency_spec.rb
+- spec/models/universal_symbol_spec.rb
 - spec/models/crypto_order_form_spec.rb
-- spec/models/figi_instrument_spec.rb
-- spec/models/pagination_details_spec.rb
-- spec/models/simple_order_form_time_in_force_spec.rb
-- spec/models/trading_instrument_spec.rb
-- spec/models/strategy_order_record_spec.rb
-- spec/models/performance_custom_spec.rb
+- spec/models/snap_trade_register_user_request_body_spec.rb
+- spec/models/auth_type_spec.rb
+- spec/models/mleg_trade_form_spec.rb
+- spec/models/option_leg_spec.rb
+- spec/models/exchange_rate_pairs_spec.rb
+- spec/models/cancel_order_response_spec.rb
+- spec/models/login_redirect_uri_spec.rb
+- spec/models/account_universal_activity_currency_spec.rb
+- spec/models/account_information_get_user_account_order_detail_request_spec.rb
+- spec/models/type_spec.rb
+- spec/models/order_type_strict_spec.rb
+- spec/models/net_contributions_spec.rb
 - spec/models/account_status_spec.rb
-- spec/models/manual_trade_form_bracket_spec.rb
-- spec/models/delete_user_response_spec.rb
-- spec/models/mleg_instrument_type_spec.rb
-- spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
-- spec/models/account_universal_activity_symbol_spec.rb
-- spec/models/symbol_exchange_spec.rb
-- spec/models/past_value_spec.rb
+- spec/models/position_currency_spec.rb
+- spec/models/cryptocurrency_pair_spec.rb
+- spec/models/cryptocurrency_pair_quote_spec.rb
 - spec/models/user_i_dand_secret_spec.rb
-- spec/models/exchange_spec.rb
-- spec/models/account_information_get_user_account_order_detail_request_spec.rb
-- spec/models/underlying_symbol_exchange_spec.rb
-- spec/models/rate_of_return_response_spec.rb
-- spec/models/option_leg_spec.rb
-- spec/models/position_spec.rb
-- spec/models/option_strategy_legs_inner_spec.rb
-- spec/models/account_order_record_child_brokerage_order_ids_spec.rb
-- spec/models/recent_orders_response_spec.rb
-- spec/models/account_order_record_v2_spec.rb
-- spec/models/model425_failed_request_response_spec.rb
-- spec/models/connection_portal_version_spec.rb
-- spec/models/model403_failed_request_response_spec.rb
-- spec/models/time_in_force_strict_spec.rb
-- spec/models/option_strategy_spec.rb
-- spec/models/strategy_quotes_spec.rb
-- spec/models/mleg_leg_spec.rb
+- spec/models/brokerage_authorization_type_read_only_spec.rb
+- spec/models/security_type_spec.rb
 - spec/models/option_brokerage_symbol_spec.rb
-- spec/models/type_spec.rb
-- spec/models/us_exchange_spec.rb
-- spec/models/mleg_trade_form_spec.rb
-- spec/models/underlying_symbol_type_spec.rb
-- spec/models/underlying_symbol_spec.rb
-- spec/models/stop_loss_spec.rb
-- spec/models/authentication_login_snap_trade_user200_response_spec.rb
-- spec/models/paginated_universal_activity_spec.rb
-- spec/models/crypto_order_form_time_in_force_spec.rb
-- spec/models/account_universal_activity_currency_spec.rb
-- spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
-- spec/models/trading_search_cryptocurrency_pair_instruments200_response_spec.rb
-- spec/models/manual_trade_form_with_options_spec.rb
-- spec/models/account_balance_total_spec.rb
-- spec/models/options_symbol_spec.rb
-- spec/models/session_event_spec.rb
-- spec/models/account_holdings_account_spec.rb
-- spec/models/crypto_trading_instrument_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
+- spec/models/account_universal_activity_option_symbol_spec.rb
+- spec/models/account_simple_spec.rb
+- spec/models/option_strategy_spec.rb
 - spec/models/symbol_query_spec.rb
-- spec/models/account_order_record_status_spec.rb
-- spec/models/account_spec.rb
-- spec/models/crypto_trading_instrument_type_spec.rb
-- spec/models/session_event_type_spec.rb
-- spec/models/model400_failed_request_response_spec.rb
-- spec/models/tax_lot_spec.rb
-- spec/models/simple_order_form_type_spec.rb
+- spec/models/strategy_order_record_spec.rb
+- spec/models/option_impact_spec.rb
 - spec/models/model403_feature_not_enabled_response_spec.rb
-- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
-- spec/models/connection_type_spec.rb
-- spec/models/order_updated_response_spec.rb
+- spec/models/trading_session_spec.rb
+- spec/models/action_strict_spec.rb
 - spec/models/crypto_order_form_type_spec.rb
+- spec/models/pagination_details_spec.rb
+- spec/models/session_event_spec.rb
+- spec/models/account_holdings_spec.rb
+- spec/models/account_order_record_leg_instrument_spec.rb
+- spec/models/manual_trade_form_notional_value_spec.rb
+- spec/models/option_strategy_legs_inner_spec.rb
+- spec/models/brokerage_authorization_spec.rb
+- spec/models/crypto_order_form_time_in_force_spec.rb
+- spec/models/encrypted_response_encrypted_message_data_spec.rb
+- spec/models/account_universal_activity_symbol_spec.rb
+- spec/models/paginated_universal_activity_spec.rb
+- spec/models/rate_of_return_response_spec.rb
+- spec/models/balance_spec.rb
+- spec/models/delete_user_response_spec.rb
+- spec/models/mleg_instrument_type_spec.rb
+- spec/models/account_order_record_spec.rb
+- spec/models/action_strict_with_options_spec.rb
+- spec/models/simple_order_form_time_in_force_spec.rb
+- spec/models/account_order_record_v2_spec.rb
+- spec/models/child_brokerage_order_ids_spec.rb
+- spec/models/encrypted_response_spec.rb
+- spec/models/position_symbol_spec.rb
+- spec/models/account_order_record_child_brokerage_order_ids_spec.rb
+- spec/models/model403_failed_request_response_spec.rb
+- spec/models/account_order_record_status_spec.rb
+- spec/models/symbol_currency_spec.rb
 - spec/spec_helper.rb