snaptrade 2.0.40 → 2.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c520ce3f1b49a19b06ea9a9691ee99f4d1abdcc9f7f497750daa603354ecd093
-  data.tar.gz: 37a836bd19e78f169b2acf5966dc62d8c817db8fd885f03fd8a6bf7d0fb39f23
+  metadata.gz: ef0e42437344c3de95a109e8b65a5297915515a37230c0aa443eaeace9213dab
+  data.tar.gz: 0d6217ba0036003029c403384e8355b2785a485e98443b6bc07513b47f482d9c
 SHA512:
-  metadata.gz: c292778ce417b1d203301fe76b4e8cb7fe2d2b31e7c2e31401c02e042e1b9f478b16c1bf031eb28122d5489cd6ea48c0f6b10061fbc9b6b663a49919a3cacceb
-  data.tar.gz: 1a1eb1acd011d807fb6dea972ada10d2972910ca8c0fd525169d15cf85c588d786525d88aa9df8050f37d9baa9fc7cf5d4d0933131d429e305274c3ce41a090f
+  metadata.gz: ff422a9c92ce394d98e1d0de8aeaee6f73e07864d8e369551be867ebd1af291aac78ac5461969e605f8b21045c269f485b1233b6b787426258991c8a6a2ea68d
+  data.tar.gz: f1a5b614e521789000a54df2252ca23191043f60ee9ee5a3a748e53683ba34a70ca555588b4d2f15de83785ec6a294389c7986b1416a4547cc1b01e32fd60642

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.40)
+    snaptrade (2.0.42)
       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.26.3)
-    parser (3.3.4.2)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -42,15 +42,14 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.9.2)
-    reline (0.5.9)
+    reline (0.5.10)
       io-console (~> 0.5)
-    rexml (3.3.6)
-      strscan
+    rexml (3.3.7)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.1)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -68,11 +67,10 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.32.1)
+    rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    strscan (3.1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS

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.40-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.40)
+[![npm](https://img.shields.io/badge/gem-v2.0.42-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.42)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.40'
+gem 'snaptrade', '~> 2.0.42'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1161,16 +1161,14 @@ p result
 
 ### `snaptrade.reference_data.get_symbols`<a id="snaptradereference_dataget_symbols"></a>
 
-Returns a list of Universal Symbol objects that match a defined string.
-
-Matches on ticker or name.
+Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
 result = snaptrade.reference_data.get_symbols(
-  substring: "apple",
+  substring: "AAPL",
 )
 p result
 ```
@@ -1178,6 +1176,8 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### substring: `String`<a id="substring-string"></a>
+The search query for symbols.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UniversalSymbol](./lib/snaptrade/models/universal_symbol.rb)
@@ -1193,7 +1193,8 @@ p result
 
 ### `snaptrade.reference_data.get_symbols_by_ticker`<a id="snaptradereference_dataget_symbols_by_ticker"></a>
 
-Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
+Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1207,7 +1208,7 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### query: `String`<a id="query-string"></a>
-The ticker or universal_symbol_id of the UniversalSymbol to get.
+The ticker or Universal Symbol ID to look up the symbol with.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1327,9 +1328,9 @@ p result
 
 ### `snaptrade.reference_data.symbol_search_user_account`<a id="snaptradereference_datasymbol_search_user_account"></a>
 
-Returns a list of universal symbols that are supported by
-the specificied account. Returned symbols are based on the
-provided search string, matching on ticker and name.
+Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+
+The search results are further limited to the symbols supported by the brokerage for which the account is under.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1339,7 +1340,7 @@ result = snaptrade.reference_data.symbol_search_user_account(
   user_id: "snaptrade-user-123",
   user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-  substring: "apple",
+  substring: "AAPL",
 )
 p result
 ```
@@ -1349,9 +1350,9 @@ p result
 ##### 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>
-The ID of the account to search for symbols within.
-
 ##### substring: `String`<a id="substring-string"></a>
+The search query for symbols.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UniversalSymbol](./lib/snaptrade/models/universal_symbol.rb)
@@ -1521,7 +1522,7 @@ Should be set to `True` if `symbols` are comprised of tickers. Defaults to
 
 ### `snaptrade.trading.place_force_order`<a id="snaptradetradingplace_force_order"></a>
 
-Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. 
+Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
 
 This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
 

data/lib/snaptrade/api/reference_data_api.rb

@@ -333,13 +333,11 @@ module SnapTrade
     end
 
 
-    # Search for symbols
+    # Search symbols
     #
-    # Returns a list of Universal Symbol objects that match a defined string.
-    # 
-    # Matches on ticker or name.
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
     #
-    # @param substring [String] 
+    # @param substring [String] The search query for symbols.
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_symbols(substring: SENTINEL, extra: {})
@@ -350,13 +348,11 @@ module SnapTrade
       data
     end
 
-    # Search for symbols
+    # Search symbols
     #
-    # Returns a list of Universal Symbol objects that match a defined string.
-    # 
-    # Matches on ticker or name.
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
     #
-    # @param substring [String] 
+    # @param substring [String] The search query for symbols.
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_symbols_with_http_info(substring: SENTINEL, extra: {})
@@ -366,8 +362,8 @@ module SnapTrade
       get_symbols_with_http_info_impl(extra)
     end
 
-    # Search for symbols
-    # Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name. 
+    # Search symbols
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. 
     # @param [Hash] opts the optional parameters
     # @option opts [SymbolQuery] :symbol_query 
     # @return [Array<UniversalSymbol>]
@@ -376,8 +372,8 @@ module SnapTrade
       data
     end
 
-    # Search for symbols
-    # Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name. 
+    # Search symbols
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. 
     # @param [Hash] opts the optional parameters
     # @option opts [SymbolQuery] :symbol_query 
     # @return [Array<(Array<UniversalSymbol>, Integer, Hash)>] Array<UniversalSymbol> data, response status code and response headers
@@ -431,30 +427,30 @@ module SnapTrade
     end
 
 
-    # Get details of a symbol
+    # Get symbol detail
     #
-    # Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
+    # Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
     #
-    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
+    # @param query [String] The ticker or Universal Symbol ID to look up the symbol with.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_symbols_by_ticker(query:, extra: {})
       data, _status_code, _headers = get_symbols_by_ticker_with_http_info_impl(query, extra)
       data
     end
 
-    # Get details of a symbol
+    # Get symbol detail
     #
-    # Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
+    # Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
     #
-    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
+    # @param query [String] The ticker or Universal Symbol ID to look up the symbol with.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_symbols_by_ticker_with_http_info(query:, extra: {})
       get_symbols_by_ticker_with_http_info_impl(query, extra)
     end
 
-    # Get details of a symbol
-    # Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
+    # Get symbol detail
+    # Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results. 
+    # @param query [String] The ticker or Universal Symbol ID to look up the symbol with.
     # @param [Hash] opts the optional parameters
     # @return [UniversalSymbol]
     private def get_symbols_by_ticker_impl(query, opts = {})
@@ -462,9 +458,9 @@ module SnapTrade
       data
     end
 
-    # Get details of a symbol
-    # Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-    # @param query [String] The ticker or universal_symbol_id of the UniversalSymbol to get.
+    # Get symbol detail
+    # Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \&quot;Yahoo Finance Market Coverage and Data Delays\&quot;). For example, for securities traded on the Toronto Stock Exchange, the symbol has a &#39;.TO&#39; suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results. 
+    # @param query [String] The ticker or Universal Symbol ID to look up the symbol with.
     # @param [Hash] opts the optional parameters
     # @return [Array<(UniversalSymbol, Integer, Hash)>] UniversalSymbol data, response status code and response headers
     private def get_symbols_by_ticker_with_http_info_impl(query, opts = {})
@@ -484,7 +480,7 @@ module SnapTrade
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -831,16 +827,16 @@ module SnapTrade
     end
 
 
-    # Search for symbols available in an account
+    # Search account symbols
     #
-    # Returns a list of universal symbols that are supported by
-    # the specificied account. Returned symbols are based on the
-    # provided search string, matching on ticker and name.
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+    # 
+    # The search results are further limited to the symbols supported by the brokerage for which the account is under.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to search for symbols within.
-    # @param substring [String] 
+    # @param account_id [String] 
+    # @param substring [String] The search query for symbols.
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def symbol_search_user_account(user_id:, user_secret:, account_id:, substring: SENTINEL, extra: {})
@@ -851,16 +847,16 @@ module SnapTrade
       data
     end
 
-    # Search for symbols available in an account
+    # Search account symbols
     #
-    # Returns a list of universal symbols that are supported by
-    # the specificied account. Returned symbols are based on the
-    # provided search string, matching on ticker and name.
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
+    # 
+    # The search results are further limited to the symbols supported by the brokerage for which the account is under.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to search for symbols within.
-    # @param substring [String] 
+    # @param account_id [String] 
+    # @param substring [String] The search query for symbols.
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def symbol_search_user_account_with_http_info(user_id:, user_secret:, account_id:, substring: SENTINEL, extra: {})
@@ -870,11 +866,11 @@ module SnapTrade
       symbol_search_user_account_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
 
-    # Search for symbols available in an account
-    # Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name. 
+    # Search account symbols
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under. 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to search for symbols within.
+    # @param account_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [SymbolQuery] :symbol_query 
     # @return [Array<UniversalSymbol>]
@@ -883,11 +879,11 @@ module SnapTrade
       data
     end
 
-    # Search for symbols available in an account
-    # Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name. 
+    # Search account symbols
+    # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under. 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to search for symbols within.
+    # @param account_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [SymbolQuery] :symbol_query 
     # @return [Array<(Array<UniversalSymbol>, Integer, Hash)>] Array<UniversalSymbol> data, response status code and response headers
@@ -918,7 +914,7 @@ module SnapTrade
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+      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?

data/lib/snaptrade/api/trading_api.rb

@@ -410,7 +410,7 @@ module SnapTrade
 
     # Place order
     #
-    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. 
+    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
     # 
     # This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
     # 
@@ -447,7 +447,7 @@ module SnapTrade
 
     # Place order
     #
-    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. 
+    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
     # 
     # This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).
     # 
@@ -482,7 +482,7 @@ module SnapTrade
     end
 
     # Place order
-    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
+    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param manual_trade_form [ManualTradeForm] 
@@ -494,7 +494,7 @@ module SnapTrade
     end
 
     # Place order
-    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
+    # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param manual_trade_form [ManualTradeForm] 

data/lib/snaptrade/models/connection_portal_version.rb

@@ -12,11 +12,12 @@ require 'time'
 
 module SnapTrade
   class ConnectionPortalVersion
-    V2 = "v2".freeze
+    V4 = "v4".freeze
     V3 = "v3".freeze
+    V2 = "v2".freeze
 
     def self.all_vars
-      @all_vars ||= [V2, V3].freeze
+      @all_vars ||= [V4, V3, V2].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/models/options_position.rb

@@ -15,7 +15,7 @@ module SnapTrade
   class OptionsPosition
     attr_accessor :symbol
 
-    # Last known market price for the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
+    # Last known market price _per share_ of the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
     attr_accessor :price
 
     # The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.

data/lib/snaptrade/models/symbol_query.rb

@@ -11,8 +11,8 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Symbol query for searching for symbols
   class SymbolQuery
+    # The search query for symbols.
     attr_accessor :substring
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/universal_activity.rb

@@ -13,7 +13,7 @@ require 'time'
 module SnapTrade
   # A transaction or activity from an institution
   class UniversalActivity
-    # Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.   Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one. 
+    # Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.  Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one. 
     attr_accessor :id
 
     attr_accessor :account

data/lib/snaptrade/version.rb

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

data/spec/api/reference_data_api_spec.rb

@@ -73,8 +73,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_symbols
-  # Search for symbols
-  # Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name. 
+  # Search symbols
+  # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. 
   # @param [Hash] opts the optional parameters
   # @option opts [SymbolQuery] :symbol_query 
   # @return [Array<UniversalSymbol>]
@@ -85,9 +85,9 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_symbols_by_ticker
-  # Get details of a symbol
-  # Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
-  # @param query The ticker or universal_symbol_id of the UniversalSymbol to get.
+  # Get symbol detail
+  # Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \&quot;Yahoo Finance Market Coverage and Data Delays\&quot;). For example, for securities traded on the Toronto Stock Exchange, the symbol has a &#39;.TO&#39; suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results. 
+  # @param query The ticker or Universal Symbol ID to look up the symbol with.
   # @param [Hash] opts the optional parameters
   # @return [UniversalSymbol]
   describe 'get_symbols_by_ticker test' do
@@ -142,11 +142,11 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for symbol_search_user_account
-  # Search for symbols available in an account
-  # Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name. 
+  # Search account symbols
+  # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.  The search results are further limited to the symbols supported by the brokerage for which the account is under. 
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account to search for symbols within.
+  # @param account_id 
   # @param [Hash] opts the optional parameters
   # @option opts [SymbolQuery] :symbol_query 
   # @return [Array<UniversalSymbol>]

data/spec/api/trading_api_spec.rb

@@ -74,7 +74,7 @@ describe 'TradingApi' do
 
   # unit tests for place_force_order
   # Place order
-  # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.   This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
+  # Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.  This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact).  It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this. 
   # @param user_id 
   # @param user_secret 
   # @param manual_trade_form 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.40
+  version: 2.0.42
 platform: ruby
 authors:
 - SnapTrade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -355,125 +355,125 @@ signing_key:
 specification_version: 4
 summary: SnapTrade Ruby Gem
 test_files:
-- spec/api/reference_data_api_spec.rb
-- spec/api/connections_api_spec.rb
-- spec/api/api_status_api_spec.rb
 - spec/api/trading_api_spec.rb
-- spec/api/account_information_api_spec.rb
-- spec/api/options_api_spec.rb
+- spec/api/connections_api_spec.rb
 - spec/api/authentication_api_spec.rb
 - spec/api/transactions_and_reporting_api_spec.rb
+- spec/api/account_information_api_spec.rb
+- spec/api/options_api_spec.rb
+- spec/api/api_status_api_spec.rb
+- spec/api/reference_data_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/getting_started_spec.rb
-- spec/models/universal_symbol_spec.rb
-- spec/models/monthly_dividends_spec.rb
-- spec/models/symbol_query_spec.rb
-- spec/models/connection_portal_version_spec.rb
-- spec/models/underlying_symbol_exchange_spec.rb
-- spec/models/type_spec.rb
-- spec/models/sub_period_return_rate_spec.rb
-- spec/models/brokerage_spec.rb
-- spec/models/underlying_symbol_spec.rb
+- spec/models/validated_trade_body_spec.rb
+- spec/models/connections_session_events200_response_inner_spec.rb
+- spec/models/option_leg_spec.rb
+- spec/models/currency_spec.rb
 - spec/models/model404_failed_request_response_spec.rb
-- spec/models/snap_trade_login_user_request_body_spec.rb
-- spec/models/universal_activity_currency_spec.rb
-- spec/models/manual_trade_form_spec.rb
-- spec/models/option_strategy_legs_inner_spec.rb
-- spec/models/session_event_type_spec.rb
+- spec/models/sub_period_return_rate_spec.rb
+- spec/models/options_symbol_spec.rb
 - spec/models/account_holdings_spec.rb
-- spec/models/exchange_spec.rb
-- spec/models/transactions_status_spec.rb
-- spec/models/brokerage_authorization_spec.rb
-- spec/models/snap_trade_holdings_account_spec.rb
-- spec/models/options_get_option_strategy_request_spec.rb
-- spec/models/net_dividend_spec.rb
-- spec/models/manual_trade_balance_spec.rb
-- spec/models/session_event_spec.rb
-- spec/models/option_strategy_spec.rb
-- spec/models/authentication_login_snap_trade_user200_response_spec.rb
-- spec/models/partner_data_spec.rb
-- spec/models/account_balance_total_spec.rb
-- spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
-- spec/models/options_position_currency_spec.rb
-- spec/models/universal_activity_spec.rb
-- spec/models/symbol_figi_instrument_spec.rb
-- spec/models/action_strict_spec.rb
-- spec/models/options_position_spec.rb
-- spec/models/balance_spec.rb
-- spec/models/strategy_quotes_spec.rb
+- spec/models/manual_trade_form_notional_value_spec.rb
+- spec/models/brokerage_type_spec.rb
+- spec/models/encrypted_response_spec.rb
+- spec/models/account_order_record_spec.rb
+- spec/models/snap_trade_register_user_request_body_spec.rb
 - spec/models/dividend_at_date_spec.rb
-- spec/models/net_contributions_spec.rb
-- spec/models/model403_failed_request_response_spec.rb
-- spec/models/currency_spec.rb
-- spec/models/strategy_order_record_status_spec.rb
-- spec/models/option_leg_spec.rb
-- spec/models/login_redirect_uri_spec.rb
-- spec/models/status_spec.rb
-- spec/models/account_spec.rb
 - spec/models/option_leg_action_spec.rb
+- spec/models/manual_trade_impact_spec.rb
+- spec/models/options_position_spec.rb
+- spec/models/option_strategy_spec.rb
 - spec/models/us_exchange_spec.rb
-- spec/models/strategy_order_record_spec.rb
-- spec/models/account_sync_status_spec.rb
-- spec/models/time_in_force_strict_spec.rb
-- spec/models/symbol_spec.rb
-- spec/models/underlying_symbol_type_spec.rb
-- spec/models/security_type_spec.rb
+- spec/models/model402_brokerage_auth_disabled_response_spec.rb
+- spec/models/manual_trade_balance_spec.rb
+- spec/models/login_redirect_uri_spec.rb
 - spec/models/account_order_record_option_symbol_spec.rb
-- spec/models/account_simple_spec.rb
-- spec/models/symbols_quotes_inner_spec.rb
-- spec/models/account_balance_spec.rb
-- spec/models/validated_trade_body_spec.rb
+- spec/models/account_order_record_universal_symbol_spec.rb
+- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
 - spec/models/brokerage_authorization_refresh_confirmation_spec.rb
-- spec/models/options_symbol_spec.rb
-- spec/models/exchange_rate_pairs_spec.rb
-- spec/models/manual_trade_impact_spec.rb
-- spec/models/manual_trade_and_impact_spec.rb
-- spec/models/auth_type_spec.rb
-- spec/models/model500_unexpected_exception_response_spec.rb
-- spec/models/symbol_exchange_spec.rb
-- spec/models/brokerage_authorization_type_read_only_spec.rb
 - spec/models/manual_trade_symbol_spec.rb
-- spec/models/user_i_dand_secret_spec.rb
-- spec/models/model403_feature_not_enabled_response_spec.rb
-- spec/models/manual_trade_spec.rb
-- spec/models/account_order_record_spec.rb
-- spec/models/trading_cancel_user_account_order_request_spec.rb
-- spec/models/manual_trade_form_notional_value_spec.rb
-- spec/models/order_type_strict_spec.rb
-- spec/models/notional_value_spec.rb
-- spec/models/brokerage_authorization_disabled_confirmation_spec.rb
-- spec/models/universal_activity_symbol_spec.rb
-- spec/models/universal_activity_option_symbol_spec.rb
-- spec/models/option_type_spec.rb
+- spec/models/account_spec.rb
 - spec/models/snap_trade_holdings_total_value_spec.rb
-- spec/models/model402_brokerage_auth_disabled_response_spec.rb
-- spec/models/option_chain_inner_chain_per_root_inner_spec.rb
-- spec/models/symbol_currency_spec.rb
-- spec/models/options_place_option_strategy_request_spec.rb
-- spec/models/strategy_quotes_greek_spec.rb
+- spec/models/account_simple_spec.rb
+- spec/models/option_chain_inner_spec.rb
+- spec/models/brokerage_authorization_type_read_only_spec.rb
+- spec/models/snap_trade_login_user_request_body_spec.rb
+- spec/models/strategy_quotes_spec.rb
+- spec/models/net_dividend_spec.rb
+- spec/models/symbol_query_spec.rb
+- spec/models/authentication_login_snap_trade_user200_response_spec.rb
+- spec/models/brokerage_authorization_spec.rb
+- spec/models/connection_type_spec.rb
+- spec/models/model403_failed_request_response_spec.rb
+- spec/models/universal_activity_spec.rb
+- spec/models/manual_trade_form_spec.rb
+- spec/models/snap_trade_holdings_account_spec.rb
 - spec/models/position_spec.rb
-- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
+- spec/models/trading_cancel_user_account_order_request_spec.rb
+- spec/models/symbols_quotes_inner_spec.rb
 - spec/models/model402_brokerage_auth_already_disabled_exception_spec.rb
-- spec/models/option_chain_inner_spec.rb
-- spec/models/account_order_record_universal_symbol_spec.rb
-- spec/models/connections_session_events200_response_inner_spec.rb
-- spec/models/balance_currency_spec.rb
+- spec/models/options_place_option_strategy_request_spec.rb
+- spec/models/account_balance_spec.rb
+- spec/models/universal_activity_symbol_spec.rb
+- spec/models/partner_data_spec.rb
+- spec/models/action_strict_spec.rb
+- spec/models/model401_failed_request_response_spec.rb
+- spec/models/symbol_spec.rb
+- spec/models/options_position_currency_spec.rb
+- spec/models/option_type_spec.rb
+- spec/models/holdings_status_spec.rb
+- spec/models/session_event_type_spec.rb
 - spec/models/figi_instrument_spec.rb
-- spec/models/encrypted_response_encrypted_message_data_spec.rb
-- spec/models/performance_custom_spec.rb
-- spec/models/past_value_spec.rb
-- spec/models/position_symbol_spec.rb
-- spec/models/encrypted_response_spec.rb
+- spec/models/model403_feature_not_enabled_response_spec.rb
+- spec/models/net_contributions_spec.rb
+- spec/models/auth_type_spec.rb
+- spec/models/strategy_type_spec.rb
+- spec/models/manual_trade_spec.rb
+- spec/models/underlying_symbol_exchange_spec.rb
 - spec/models/account_order_record_status_spec.rb
-- spec/models/connection_type_spec.rb
-- spec/models/snap_trade_register_user_request_body_spec.rb
+- spec/models/exchange_rate_pairs_spec.rb
+- spec/models/symbol_figi_instrument_spec.rb
 - spec/models/delete_user_response_spec.rb
-- spec/models/strategy_type_spec.rb
-- spec/models/brokerage_type_spec.rb
-- spec/models/holdings_status_spec.rb
+- spec/models/brokerage_authorization_disabled_confirmation_spec.rb
+- spec/models/order_type_strict_spec.rb
+- spec/models/options_get_option_strategy_request_spec.rb
 - spec/models/option_brokerage_symbol_spec.rb
-- spec/models/model401_failed_request_response_spec.rb
+- spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
+- spec/models/account_sync_status_spec.rb
+- spec/models/universal_activity_option_symbol_spec.rb
+- spec/models/model500_unexpected_exception_response_spec.rb
+- spec/models/manual_trade_and_impact_spec.rb
+- spec/models/connection_portal_version_spec.rb
+- spec/models/underlying_symbol_type_spec.rb
+- spec/models/balance_spec.rb
+- spec/models/universal_activity_currency_spec.rb
+- spec/models/type_spec.rb
+- spec/models/symbol_exchange_spec.rb
+- spec/models/exchange_spec.rb
+- spec/models/symbol_currency_spec.rb
+- spec/models/position_symbol_spec.rb
+- spec/models/performance_custom_spec.rb
+- spec/models/status_spec.rb
+- spec/models/brokerage_spec.rb
+- spec/models/strategy_order_record_status_spec.rb
+- spec/models/monthly_dividends_spec.rb
+- spec/models/strategy_order_record_spec.rb
+- spec/models/time_in_force_strict_spec.rb
 - spec/models/model400_failed_request_response_spec.rb
+- spec/models/past_value_spec.rb
+- spec/models/encrypted_response_encrypted_message_data_spec.rb
 - spec/models/account_holdings_account_spec.rb
+- spec/models/option_strategy_legs_inner_spec.rb
+- spec/models/account_balance_total_spec.rb
+- spec/models/transactions_status_spec.rb
+- spec/models/security_type_spec.rb
+- spec/models/balance_currency_spec.rb
+- spec/models/session_event_spec.rb
+- spec/models/brokerage_authorization_type_read_only_brokerage_spec.rb
+- spec/models/notional_value_spec.rb
+- spec/models/user_i_dand_secret_spec.rb
+- spec/models/universal_symbol_spec.rb
+- spec/models/underlying_symbol_spec.rb
+- spec/models/strategy_quotes_greek_spec.rb
 - spec/spec_helper.rb