snaptrade 2.0.172 → 2.0.174

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13aaf2e483a1087e202cf2a72db5754d347a7cf59bcb373f9f31e90a5ea7b36e
-  data.tar.gz: 9252ce76879156f6fc12e0ebaa6e59ecf3883f41e526872be4f3f4c49ee4403c
+  metadata.gz: 3efae43f8628cbe19a4de381ce7dcd918ecdcb4fb5ac12b4e0b4434e8e57990d
+  data.tar.gz: 449e148b180601757110ef99a3ddc188ae3e198bcec73b8dc54e945f28571e6f
 SHA512:
-  metadata.gz: 4be7c89dbc9dcbc79377e2de9cef48ed1af1220702d0421c0c11ca846fa8edf1dfad5675d669670fc40f6e1e783056460e45574a06926b6d812bd53adfc45203
-  data.tar.gz: f60d32bef575a1fe4cd589aba951ce59ff9f967e808fad570acfefdede2a272672b7b8b7a2e0912f760f97d2e116feae40bf11079e86e4e3e590da7c0f3f249b
+  metadata.gz: c18beddf828ca16284b16830d31091512834b6091fe569a38a8dfbf5c12a2d7cc3b536a99850784af4cffb1557e05a4d184d369c5f75c68774a66c5304f412f7
+  data.tar.gz: b4dbb4089da49fcf83384377e1175e77de0ceb2c3e55960237d20bbe71dc7cf6f656e8afa8b5dfa9d4076f777c3279e22d9ec8f82a2a3a3fd713382396c8dca7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.172)
+    snaptrade (2.0.174)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

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.172-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.172)
+[![npm](https://img.shields.io/badge/gem-v2.0.174-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.174)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -49,7 +49,6 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
-  * [`snaptrade.options.get_option_quote`](#snaptradeoptionsget_option_quote)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
@@ -87,7 +86,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.172'
+gem 'snaptrade', '~> 2.0.174'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1334,44 +1333,6 @@ false to retrieve non executed orders as well
 ---
 
 
-### `snaptrade.options.get_option_quote`<a id="snaptradeoptionsget_option_quote"></a>
-
-Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```ruby
-result = snaptrade.options.get_option_quote(
-  user_id: "snaptrade-user-123",
-  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-  symbol: "AAPL  251219C00150000",
-)
-p result
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></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>
-##### symbol: `String`<a id="symbol-string"></a>
-The OCC-formatted option symbol.
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[OptionQuote](./lib/snaptrade/models/option_quote.rb)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/quotes/options` `GET`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
-
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
 Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
@@ -1871,7 +1832,7 @@ 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 the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
+Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>

data/lib/snaptrade/api/options_api.rb

@@ -17,118 +17,6 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Get option quote
-    #
-    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
-    #
-    # @param user_id [String] 
-    # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param symbol [String] The OCC-formatted option symbol.
-    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_option_quote(user_id:, user_secret:, account_id:, symbol:, extra: {})
-      data, _status_code, _headers = get_option_quote_with_http_info_impl(user_id, user_secret, account_id, symbol, extra)
-      data
-    end
-
-    # Get option quote
-    #
-    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
-    #
-    # @param user_id [String] 
-    # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param symbol [String] The OCC-formatted option symbol.
-    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_option_quote_with_http_info(user_id:, user_secret:, account_id:, symbol:, extra: {})
-      get_option_quote_with_http_info_impl(user_id, user_secret, account_id, symbol, extra)
-    end
-
-    # Get option quote
-    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) 
-    # @param user_id [String] 
-    # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param symbol [String] The OCC-formatted option symbol.
-    # @param [Hash] opts the optional parameters
-    # @return [OptionQuote]
-    private def get_option_quote_impl(user_id, user_secret, account_id, symbol, opts = {})
-      data, _status_code, _headers = get_option_quote_with_http_info(user_id, user_secret, account_id, symbol, opts)
-      data
-    end
-
-    # Get option quote
-    # Returns a real-time quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) 
-    # @param user_id [String] 
-    # @param user_secret [String] 
-    # @param account_id [String] 
-    # @param symbol [String] The OCC-formatted option symbol.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(OptionQuote, Integer, Hash)>] OptionQuote data, response status code and response headers
-    private def get_option_quote_with_http_info_impl(user_id, user_secret, account_id, symbol, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: OptionsApi.get_option_quote ...'
-      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 OptionsApi.get_option_quote"
-      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 OptionsApi.get_option_quote"
-      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 OptionsApi.get_option_quote"
-      end
-      # verify the required parameter 'symbol' is set
-      if @api_client.config.client_side_validation && symbol.nil?
-        fail ArgumentError, "Missing the required parameter 'symbol' when calling OptionsApi.get_option_quote"
-      end
-      # resource path
-      local_var_path = '/accounts/{accountId}/quotes/options'.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
-      query_params[:'symbol'] = symbol
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'OptionQuote'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
-
-      new_options = opts.merge(
-        :operation => :"OptionsApi.get_option_quote",
-        :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(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OptionsApi#get_option_quote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers, response
-    end
-
-
     # List account option positions
     #
     # Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).

data/lib/snaptrade/api/trading_api.rb

@@ -381,7 +381,7 @@ module SnapTrade
     # 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 the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
+    # Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
     #
     # @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. 
@@ -410,7 +410,7 @@ module SnapTrade
     # 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 the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
+    # Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
     #
     # @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. 
@@ -436,7 +436,7 @@ 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 the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint. 
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -449,7 +449,7 @@ 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 the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint. 
+    # Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 

data/lib/snaptrade/models/option_quote.rb

@@ -16,54 +16,25 @@ module SnapTrade
     # The OCC-formatted option symbol.
     attr_accessor :symbol
 
-    # The best bid price for the option contract.
-    attr_accessor :bid_price
-
-    # The number of contracts available at the bid price.
-    attr_accessor :bid_size
-
-    # The best ask price for the option contract.
-    attr_accessor :ask_price
-
-    # The number of contracts available at the ask price.
-    attr_accessor :ask_size
-
-    # The price of the last trade for the option contract.
-    attr_accessor :last_price
-
-    # The number of contracts in the last trade.
-    attr_accessor :last_size
-
-    # The total number of outstanding contracts.
-    attr_accessor :open_interest
-
-    # The total number of contracts traded during the current session.
-    attr_accessor :volume
+    # The derived synthetic price of the contract.
+    attr_accessor :synthetic_price
 
     # The implied volatility of the option contract.
     attr_accessor :implied_volatility
 
-    # The current price of the underlying security.
-    attr_accessor :underlying_price
-
-    # The timestamp of the quote.
+    # The timestamp of the last update for the option quote.
     attr_accessor :timestamp
 
+    attr_accessor :greeks
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'symbol' => :'symbol',
-        :'bid_price' => :'bid_price',
-        :'bid_size' => :'bid_size',
-        :'ask_price' => :'ask_price',
-        :'ask_size' => :'ask_size',
-        :'last_price' => :'last_price',
-        :'last_size' => :'last_size',
-        :'open_interest' => :'open_interest',
-        :'volume' => :'volume',
+        :'synthetic_price' => :'synthetic_price',
         :'implied_volatility' => :'implied_volatility',
-        :'underlying_price' => :'underlying_price',
-        :'timestamp' => :'timestamp'
+        :'timestamp' => :'timestamp',
+        :'greeks' => :'greeks'
       }
     end
 
@@ -76,24 +47,17 @@ module SnapTrade
     def self.openapi_types
       {
         :'symbol' => :'String',
-        :'bid_price' => :'Float',
-        :'bid_size' => :'Integer',
-        :'ask_price' => :'Float',
-        :'ask_size' => :'Integer',
-        :'last_price' => :'Float',
-        :'last_size' => :'Integer',
-        :'open_interest' => :'Integer',
-        :'volume' => :'Integer',
+        :'synthetic_price' => :'Float',
         :'implied_volatility' => :'Float',
-        :'underlying_price' => :'Float',
-        :'timestamp' => :'Time'
+        :'timestamp' => :'Time',
+        :'greeks' => :'OptionQuoteGreeks'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'timestamp'
+        :'timestamp',
       ])
     end
 
@@ -116,49 +80,21 @@ module SnapTrade
         self.symbol = attributes[:'symbol']
       end
 
-      if attributes.key?(:'bid_price')
-        self.bid_price = attributes[:'bid_price']
-      end
-
-      if attributes.key?(:'bid_size')
-        self.bid_size = attributes[:'bid_size']
-      end
-
-      if attributes.key?(:'ask_price')
-        self.ask_price = attributes[:'ask_price']
-      end
-
-      if attributes.key?(:'ask_size')
-        self.ask_size = attributes[:'ask_size']
-      end
-
-      if attributes.key?(:'last_price')
-        self.last_price = attributes[:'last_price']
-      end
-
-      if attributes.key?(:'last_size')
-        self.last_size = attributes[:'last_size']
-      end
-
-      if attributes.key?(:'open_interest')
-        self.open_interest = attributes[:'open_interest']
-      end
-
-      if attributes.key?(:'volume')
-        self.volume = attributes[:'volume']
+      if attributes.key?(:'synthetic_price')
+        self.synthetic_price = attributes[:'synthetic_price']
       end
 
       if attributes.key?(:'implied_volatility')
         self.implied_volatility = attributes[:'implied_volatility']
       end
 
-      if attributes.key?(:'underlying_price')
-        self.underlying_price = attributes[:'underlying_price']
-      end
-
       if attributes.key?(:'timestamp')
         self.timestamp = attributes[:'timestamp']
       end
+
+      if attributes.key?(:'greeks')
+        self.greeks = attributes[:'greeks']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -180,17 +116,10 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           symbol == o.symbol &&
-          bid_price == o.bid_price &&
-          bid_size == o.bid_size &&
-          ask_price == o.ask_price &&
-          ask_size == o.ask_size &&
-          last_price == o.last_price &&
-          last_size == o.last_size &&
-          open_interest == o.open_interest &&
-          volume == o.volume &&
+          synthetic_price == o.synthetic_price &&
           implied_volatility == o.implied_volatility &&
-          underlying_price == o.underlying_price &&
-          timestamp == o.timestamp
+          timestamp == o.timestamp &&
+          greeks == o.greeks
     end
 
     # @see the `==` method
@@ -202,7 +131,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, bid_price, bid_size, ask_price, ask_size, last_price, last_size, open_interest, volume, implied_volatility, underlying_price, timestamp].hash
+      [symbol, synthetic_price, implied_volatility, timestamp, greeks].hash
     end
 
     # Builds the object from hash