snaptrade 2.0.16 → 2.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d202c0c9f1f0e2d382cfb023056110f08727158e34c12f5d61ccf70061d2a991
-  data.tar.gz: d6535b39985caa7570ff9a002f0284c9b2a7553ce5a8821f29db6c0e0e810836
+  metadata.gz: a363cc77c3f0d1064c2e6f173c15b0526b4a9e5a68bea6e38ef869c6377fd9ad
+  data.tar.gz: d2f7de1e5805be1d96d2f47d0263889abb5165576a0230d06704e9e223053afd
 SHA512:
-  metadata.gz: 6a01fca1b933ba9aecf52ad6b779cb57bd5d04360138ae87c740b3e1bf3fdd2b301e036f7159fd979f831aedbad98cdb2b8342beb24bfd87913684bbc8894809
-  data.tar.gz: fa8f2dff41a36d48337f2223245a70dc40c478da18dfede9a5fe1e0b96971cabef62664b446af834a7fdf1245fb1a803ea0815397af6ef47389795e259e5432f
+  metadata.gz: 1711b6758368a02f9c7b247f9321aac58a7cfc0a1566da2cce4696b36887b352c63e341132395ef1f49e50432917a8ffa40eef197e4804441de448156c1fb6a0
+  data.tar.gz: d14162342db37f27e21f320f2ef837208895f274105642f13d13baf17ee2f9c87258515611a5e2d338452ae91a43e8c8a2cab18d00cb16e51f35063888abcdf2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.15)
+    snaptrade (2.0.17)
       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.16-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.16)
+[![npm](https://img.shields.io/badge/gem-v2.0.18-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.18)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -69,7 +69,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.16'
+gem 'snaptrade', '~> 2.0.18'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -264,7 +264,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
 
 ### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
 
-Returns a list of positions in the the specified account.
+Returns a list of positions in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -641,7 +641,7 @@ SnapTrade user.
 
 ### `snaptrade.connections.detail_brokerage_authorization`<a id="snaptradeconnectionsdetail_brokerage_authorization"></a>
 
-Get brokerage authorization details
+Returns a single brokerage authorization object for the specified ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -676,7 +676,7 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.list_brokerage_authorizations`<a id="snaptradeconnectionslist_brokerage_authorizations"></a>
 
-List all brokerage authorizations for the user
+Returns a list of Brokerage Authorization objects for the user
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -707,7 +707,7 @@ p result
 
 ### `snaptrade.connections.remove_brokerage_authorization`<a id="snaptradeconnectionsremove_brokerage_authorization"></a>
 
-Delete brokerage authorization
+Deletes a specified brokerage authorization given by the ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -737,7 +737,7 @@ The ID of the Authorization to delete.
 
 ### `snaptrade.connections.session_events`<a id="snaptradeconnectionssession_events"></a>
 
-List all session events for the partner
+Returns a list of session events associated with a user.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -776,7 +776,8 @@ specific users
 
 ### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
 
-Creates an option strategy object that will be used to place an option strategy order
+Creates an option strategy object that will be used to place an option strategy order.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -823,7 +824,7 @@ The ID of the account to create the option strategy object in.
 
 ### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
 
-Get the options chain
+Returns the option chain for the specified symbol in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -862,7 +863,8 @@ Universal symbol ID if symbol
 
 ### `snaptrade.options.get_options_strategy_quote`<a id="snaptradeoptionsget_options_strategy_quote"></a>
 
-Get latest market data of option strategy
+Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -901,7 +903,8 @@ Option strategy id obtained from response when creating option strategy object
 
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
-Get the options holdings in the account
+Returns a list of Options Positions.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -936,7 +939,7 @@ The ID of the account to fetch options holdings for.
 
 ### `snaptrade.options.place_option_strategy`<a id="snaptradeoptionsplace_option_strategy"></a>
 
-Place an option strategy order on the brokerage
+Places the option strategy order and returns the order record received from the brokerage.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -988,7 +991,7 @@ Trade Price if limit or stop limit order
 
 ### `snaptrade.reference_data.get_currency_exchange_rate_pair`<a id="snaptradereference_dataget_currency_exchange_rate_pair"></a>
 
-Return the exchange rate of a currency pair
+Returns an Exchange Rate Pair object for the specified Currency Pair.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1067,7 +1070,7 @@ p result
 
 ### `snaptrade.reference_data.get_stock_exchanges`<a id="snaptradereference_dataget_stock_exchanges"></a>
 
-List exchanges
+Returns a list of all supported Exchanges.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1091,7 +1094,10 @@ p result
 
 ### `snaptrade.reference_data.get_symbols`<a id="snaptradereference_dataget_symbols"></a>
 
-Search for symbols
+Returns a list of Universal Symbol objects that match a defined string.
+
+Matches on ticker or name.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1120,7 +1126,7 @@ p result
 
 ### `snaptrade.reference_data.get_symbols_by_ticker`<a id="snaptradereference_dataget_symbols_by_ticker"></a>
 
-Get details of a symbol by the ticker or the universal_symbol_id
+Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1151,7 +1157,7 @@ The ticker or universal_symbol_id of the UniversalSymbol to get.
 
 ### `snaptrade.reference_data.list_all_brokerage_authorization_type`<a id="snaptradereference_datalist_all_brokerage_authorization_type"></a>
 
-List of all brokerage authorization types
+Returns a list of all defined Brokerage authorization Type objects.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1182,7 +1188,7 @@ Comma separated value of brokerage slugs
 
 ### `snaptrade.reference_data.list_all_brokerages`<a id="snaptradereference_datalist_all_brokerages"></a>
 
-List brokerages
+Returns a list of all defined Brokerage objects.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1206,7 +1212,7 @@ p result
 
 ### `snaptrade.reference_data.list_all_currencies`<a id="snaptradereference_datalist_all_currencies"></a>
 
-List currencies
+Returns a list of all defined Currency objects.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1230,7 +1236,7 @@ p result
 
 ### `snaptrade.reference_data.list_all_currencies_rates`<a id="snaptradereference_datalist_all_currencies_rates"></a>
 
-List currency exchange rates
+Returns a list of all Exchange Rate Pairs for all supported Currencies.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1333,7 +1339,7 @@ The ID of the account to cancel the order in.
 
 ### `snaptrade.trading.get_order_impact`<a id="snaptradetradingget_order_impact"></a>
 
-Check impact of trades on account.
+Return the trade object and it's impact on the account for the specified order.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1436,7 +1442,7 @@ Should be set to True if providing tickers.
 
 ### `snaptrade.trading.place_force_order`<a id="snaptradetradingplace_force_order"></a>
 
-Place a trade with NO validation.
+Places a specified trade in the specified account.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1496,7 +1502,9 @@ Canceled
 
 ### `snaptrade.trading.place_order`<a id="snaptradetradingplace_order"></a>
 
-Place order
+Places the specified trade object. This places the order in the account and
+returns the status of the order from the brokerage.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -456,7 +456,7 @@ module SnapTrade
 
     # List account positions
     #
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -469,7 +469,7 @@ module SnapTrade
 
     # List account positions
     #
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -480,7 +480,7 @@ module SnapTrade
     end
 
     # List account positions
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.
@@ -492,7 +492,7 @@ module SnapTrade
     end
 
     # List account positions
-    # Returns a list of positions in the the specified account.
+    # Returns a list of positions in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get positions.

data/lib/snaptrade/api/connections_api.rb

@@ -19,6 +19,8 @@ module SnapTrade
 
     # Get brokerage authorization details
     #
+    # Returns a single brokerage authorization object for the specified ID.
+    #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -30,6 +32,8 @@ module SnapTrade
 
     # Get brokerage authorization details
     #
+    # Returns a single brokerage authorization object for the specified ID.
+    #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -39,6 +43,7 @@ module SnapTrade
     end
 
     # Get brokerage authorization details
+    # Returns a single brokerage authorization object for the specified ID.
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -50,6 +55,7 @@ module SnapTrade
     end
 
     # Get brokerage authorization details
+    # Returns a single brokerage authorization object for the specified ID.
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -114,7 +120,9 @@ module SnapTrade
     end
 
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    #
+    # Returns a list of Brokerage Authorization objects for the user
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -124,7 +132,9 @@ module SnapTrade
       data
     end
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    #
+    # Returns a list of Brokerage Authorization objects for the user
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -133,7 +143,8 @@ module SnapTrade
       list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
     end
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    # Returns a list of Brokerage Authorization objects for the user
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -143,7 +154,8 @@ module SnapTrade
       data
     end
 
-    # List all brokerage authorizations for the user
+    # List all brokerage authorizations for the User
+    # Returns a list of Brokerage Authorization objects for the user
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -205,6 +217,8 @@ module SnapTrade
 
     # Delete brokerage authorization
     #
+    # Deletes a specified brokerage authorization given by the ID.
+    #
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -216,6 +230,8 @@ module SnapTrade
 
     # Delete brokerage authorization
     #
+    # Deletes a specified brokerage authorization given by the ID.
+    #
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -225,6 +241,7 @@ module SnapTrade
     end
 
     # Delete brokerage authorization
+    # Deletes a specified brokerage authorization given by the ID.
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -236,6 +253,7 @@ module SnapTrade
     end
 
     # Delete brokerage authorization
+    # Deletes a specified brokerage authorization given by the ID.
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -298,7 +316,9 @@ module SnapTrade
     end
 
 
-    # List all session events for the partner
+    # Get all session events for a user
+    #
+    # Returns a list of session events associated with a user.
     #
     # @param partner_client_id [String] 
     # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
@@ -311,7 +331,9 @@ module SnapTrade
       data
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    #
+    # Returns a list of session events associated with a user.
     #
     # @param partner_client_id [String] 
     # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
@@ -323,7 +345,8 @@ module SnapTrade
       session_events_with_http_info_impl(partner_client_id, extra)
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
@@ -334,7 +357,8 @@ module SnapTrade
       data
     end
 
-    # List all session events for the partner
+    # Get all session events for a user
+    # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users

data/lib/snaptrade/api/options_api.rb

@@ -17,7 +17,9 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    #
+    # Creates an option strategy object that will be used to place an option strategy order.
     #
     # @param underlying_symbol_id [String] 
     # @param legs [Array<OptionLeg>] 
@@ -37,7 +39,9 @@ module SnapTrade
       data
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    #
+    # Creates an option strategy object that will be used to place an option strategy order.
     #
     # @param underlying_symbol_id [String] 
     # @param legs [Array<OptionLeg>] 
@@ -56,7 +60,8 @@ module SnapTrade
       get_option_strategy_with_http_info_impl(user_id, user_secret, account_id, options_get_option_strategy_request, extra)
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    # Creates an option strategy object that will be used to place an option strategy order. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to create the option strategy object in.
@@ -68,7 +73,8 @@ module SnapTrade
       data
     end
 
-    # Creates an option strategy object that will be used to place an option strategy order
+    # Create options strategy
+    # Creates an option strategy object that will be used to place an option strategy order. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to create the option strategy object in.
@@ -143,7 +149,9 @@ module SnapTrade
     end
 
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    #
+    # Returns the option chain for the specified symbol in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -155,7 +163,9 @@ module SnapTrade
       data
     end
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    #
+    # Returns the option chain for the specified symbol in the specified account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -166,7 +176,8 @@ module SnapTrade
       get_options_chain_with_http_info_impl(user_id, user_secret, account_id, symbol, extra)
     end
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    # Returns the option chain for the specified symbol in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get the options chain from.
@@ -178,7 +189,8 @@ module SnapTrade
       data
     end
 
-    # Get the options chain
+    # Get the options chain for a symbol
+    # Returns the option chain for the specified symbol in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get the options chain from.
@@ -249,7 +261,9 @@ module SnapTrade
     end
 
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    #
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -261,7 +275,9 @@ module SnapTrade
       data
     end
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    #
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -272,7 +288,8 @@ module SnapTrade
       get_options_strategy_quote_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, extra)
     end
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account the strategy will be placed in.
@@ -284,7 +301,8 @@ module SnapTrade
       data
     end
 
-    # Get latest market data of option strategy
+    # Get options strategy quotes
+    # Returns a Strategy Quotes object which has latest market data of the specified option strategy. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account the strategy will be placed in.
@@ -354,7 +372,9 @@ module SnapTrade
     end
 
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    #
+    # Returns a list of Options Positions.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -365,7 +385,9 @@ module SnapTrade
       data
     end
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    #
+    # Returns a list of Options Positions.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -375,7 +397,8 @@ module SnapTrade
       list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    # Returns a list of Options Positions. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to fetch options holdings for.
@@ -386,7 +409,8 @@ module SnapTrade
       data
     end
 
-    # Get the options holdings in the account
+    # Get account option holdings
+    # Returns a list of Options Positions. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to fetch options holdings for.
@@ -451,7 +475,9 @@ module SnapTrade
     end
 
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    #
+    # Places the option strategy order and returns the order record received from the brokerage.
     #
     # @param order_type [OrderType] Order Type
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
@@ -472,7 +498,9 @@ module SnapTrade
       data
     end
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    #
+    # Places the option strategy order and returns the order record received from the brokerage.
     #
     # @param order_type [OrderType] Order Type
     # @param time_in_force [TimeInForceStrict] Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Good Til Canceled 
@@ -492,7 +520,8 @@ module SnapTrade
       place_option_strategy_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, extra)
     end
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    # Places the option strategy order and returns the order record received from the brokerage.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.
@@ -505,7 +534,8 @@ module SnapTrade
       data
     end
 
-    # Place an option strategy order on the brokerage
+    # Place an option strategy order
+    # Places the option strategy order and returns the order record received from the brokerage.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.

data/lib/snaptrade/api/reference_data_api.rb

@@ -17,7 +17,9 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Return the exchange rate of a currency pair
+    # Get exchange rate of a currency pair
+    #
+    # Returns an Exchange Rate Pair object for the specified Currency Pair.
     #
     # @param currency_pair [String] A currency pair based on currency code for example, {CAD-USD}
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -26,7 +28,9 @@ module SnapTrade
       data
     end
 
-    # Return the exchange rate of a currency pair
+    # Get exchange rate of a currency pair
+    #
+    # Returns an Exchange Rate Pair object for the specified Currency Pair.
     #
     # @param currency_pair [String] A currency pair based on currency code for example, {CAD-USD}
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -34,7 +38,8 @@ module SnapTrade
       get_currency_exchange_rate_pair_with_http_info_impl(currency_pair, extra)
     end
 
-    # Return the exchange rate of a currency pair
+    # Get exchange rate of a currency pair
+    # Returns an Exchange Rate Pair object for the specified Currency Pair.
     # @param currency_pair [String] A currency pair based on currency code for example, {CAD-USD}
     # @param [Hash] opts the optional parameters
     # @return [ExchangeRatePairs]
@@ -43,7 +48,8 @@ module SnapTrade
       data
     end
 
-    # Return the exchange rate of a currency pair
+    # Get exchange rate of a currency pair
+    # Returns an Exchange Rate Pair object for the specified Currency Pair.
     # @param currency_pair [String] A currency pair based on currency code for example, {CAD-USD}
     # @param [Hash] opts the optional parameters
     # @return [Array<(ExchangeRatePairs, Integer, Hash)>] ExchangeRatePairs data, response status code and response headers
@@ -250,7 +256,9 @@ module SnapTrade
     end
 
 
-    # List exchanges
+    # Get exchanges
+    #
+    # Returns a list of all supported Exchanges.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_stock_exchanges(extra: {})
@@ -258,14 +266,17 @@ module SnapTrade
       data
     end
 
-    # List exchanges
+    # Get exchanges
+    #
+    # Returns a list of all supported Exchanges.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_stock_exchanges_with_http_info(extra: {})
       get_stock_exchanges_with_http_info_impl(extra)
     end
 
-    # List exchanges
+    # Get exchanges
+    # Returns a list of all supported Exchanges.
     # @param [Hash] opts the optional parameters
     # @return [Array<Exchange>]
     private def get_stock_exchanges_impl(opts = {})
@@ -273,7 +284,8 @@ module SnapTrade
       data
     end
 
-    # List exchanges
+    # Get exchanges
+    # Returns a list of all supported Exchanges.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Exchange>, Integer, Hash)>] Array<Exchange> data, response status code and response headers
     private def get_stock_exchanges_with_http_info_impl(opts = {})
@@ -323,6 +335,10 @@ module SnapTrade
 
     # Search for symbols
     #
+    # Returns a list of Universal Symbol objects that match a defined string.
+    # 
+    # Matches on ticker or name.
+    #
     # @param substring [String] 
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -336,6 +352,10 @@ module SnapTrade
 
     # Search for symbols
     #
+    # Returns a list of Universal Symbol objects that match a defined string.
+    # 
+    # Matches on ticker or name.
+    #
     # @param substring [String] 
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -347,6 +367,7 @@ module SnapTrade
     end
 
     # Search for symbols
+    # Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name. 
     # @param [Hash] opts the optional parameters
     # @option opts [SymbolQuery] :symbol_query 
     # @return [Array<UniversalSymbol>]
@@ -356,6 +377,7 @@ module SnapTrade
     end
 
     # Search for symbols
+    # Returns a list of Universal Symbol objects that match a defined string.  Matches on ticker or name. 
     # @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
@@ -409,7 +431,9 @@ module SnapTrade
     end
 
 
-    # Get details of a symbol by the ticker or the universal_symbol_id
+    # 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.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -418,7 +442,9 @@ module SnapTrade
       data
     end
 
-    # Get details of a symbol by the ticker or the universal_symbol_id
+    # 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.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -426,7 +452,8 @@ module SnapTrade
       get_symbols_by_ticker_with_http_info_impl(query, extra)
     end
 
-    # Get details of a symbol by the ticker or the universal_symbol_id
+    # 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.
     # @param [Hash] opts the optional parameters
     # @return [UniversalSymbol]
@@ -435,7 +462,8 @@ module SnapTrade
       data
     end
 
-    # Get details of a symbol by the ticker or the universal_symbol_id
+    # 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.
     # @param [Hash] opts the optional parameters
     # @return [Array<(UniversalSymbol, Integer, Hash)>] UniversalSymbol data, response status code and response headers
@@ -488,7 +516,9 @@ module SnapTrade
     end
 
 
-    # List of all brokerage authorization types
+    # Get all brokerage authorization types
+    #
+    # Returns a list of all defined Brokerage authorization Type objects.
     #
     # @param brokerage [String] Comma separated value of brokerage slugs
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -498,7 +528,9 @@ module SnapTrade
       data
     end
 
-    # List of all brokerage authorization types
+    # Get all brokerage authorization types
+    #
+    # Returns a list of all defined Brokerage authorization Type objects.
     #
     # @param brokerage [String] Comma separated value of brokerage slugs
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -507,7 +539,8 @@ module SnapTrade
       list_all_brokerage_authorization_type_with_http_info_impl(extra)
     end
 
-    # List of all brokerage authorization types
+    # Get all brokerage authorization types
+    # Returns a list of all defined Brokerage authorization Type objects.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :brokerage Comma separated value of brokerage slugs
     # @return [Array<BrokerageAuthorizationTypeReadOnly>]
@@ -516,7 +549,8 @@ module SnapTrade
       data
     end
 
-    # List of all brokerage authorization types
+    # Get all brokerage authorization types
+    # Returns a list of all defined Brokerage authorization Type objects.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :brokerage Comma separated value of brokerage slugs
     # @return [Array<(Array<BrokerageAuthorizationTypeReadOnly>, Integer, Hash)>] Array<BrokerageAuthorizationTypeReadOnly> data, response status code and response headers
@@ -566,7 +600,9 @@ module SnapTrade
     end
 
 
-    # List brokerages
+    # Get brokerages
+    #
+    # Returns a list of all defined Brokerage objects.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_brokerages(extra: {})
@@ -574,14 +610,17 @@ module SnapTrade
       data
     end
 
-    # List brokerages
+    # Get brokerages
+    #
+    # Returns a list of all defined Brokerage objects.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_brokerages_with_http_info(extra: {})
       list_all_brokerages_with_http_info_impl(extra)
     end
 
-    # List brokerages
+    # Get brokerages
+    # Returns a list of all defined Brokerage objects.
     # @param [Hash] opts the optional parameters
     # @return [Array<Brokerage>]
     private def list_all_brokerages_impl(opts = {})
@@ -589,7 +628,8 @@ module SnapTrade
       data
     end
 
-    # List brokerages
+    # Get brokerages
+    # Returns a list of all defined Brokerage objects.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Brokerage>, Integer, Hash)>] Array<Brokerage> data, response status code and response headers
     private def list_all_brokerages_with_http_info_impl(opts = {})
@@ -637,7 +677,9 @@ module SnapTrade
     end
 
 
-    # List currencies
+    # Get currencies
+    #
+    # Returns a list of all defined Currency objects.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies(extra: {})
@@ -645,14 +687,17 @@ module SnapTrade
       data
     end
 
-    # List currencies
+    # Get currencies
+    #
+    # Returns a list of all defined Currency objects.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies_with_http_info(extra: {})
       list_all_currencies_with_http_info_impl(extra)
     end
 
-    # List currencies
+    # Get currencies
+    # Returns a list of all defined Currency objects.
     # @param [Hash] opts the optional parameters
     # @return [Array<Currency>]
     private def list_all_currencies_impl(opts = {})
@@ -660,7 +705,8 @@ module SnapTrade
       data
     end
 
-    # List currencies
+    # Get currencies
+    # Returns a list of all defined Currency objects.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Currency>, Integer, Hash)>] Array<Currency> data, response status code and response headers
     private def list_all_currencies_with_http_info_impl(opts = {})
@@ -708,7 +754,9 @@ module SnapTrade
     end
 
 
-    # List currency exchange rates
+    # Get currency exchange rates
+    #
+    # Returns a list of all Exchange Rate Pairs for all supported Currencies.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies_rates(extra: {})
@@ -716,14 +764,17 @@ module SnapTrade
       data
     end
 
-    # List currency exchange rates
+    # Get currency exchange rates
+    #
+    # Returns a list of all Exchange Rate Pairs for all supported Currencies.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_all_currencies_rates_with_http_info(extra: {})
       list_all_currencies_rates_with_http_info_impl(extra)
     end
 
-    # List currency exchange rates
+    # Get currency exchange rates
+    # Returns a list of all Exchange Rate Pairs for all supported Currencies.
     # @param [Hash] opts the optional parameters
     # @return [Array<ExchangeRatePairs>]
     private def list_all_currencies_rates_impl(opts = {})
@@ -731,7 +782,8 @@ module SnapTrade
       data
     end
 
-    # List currency exchange rates
+    # Get currency exchange rates
+    # Returns a list of all Exchange Rate Pairs for all supported Currencies.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<ExchangeRatePairs>, Integer, Hash)>] Array<ExchangeRatePairs> data, response status code and response headers
     private def list_all_currencies_rates_with_http_info_impl(opts = {})

data/lib/snaptrade/api/trading_api.rb

@@ -143,7 +143,9 @@ module SnapTrade
     end
 
 
-    # Check impact of trades on account.
+    # Check the impact of a trade on an account
+    #
+    # Return the trade object and it's impact on the account for the specified order.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -174,7 +176,9 @@ module SnapTrade
       data
     end
 
-    # Check impact of trades on account.
+    # Check the impact of a trade on an account
+    #
+    # Return the trade object and it's impact on the account for the specified order.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -204,7 +208,8 @@ module SnapTrade
       get_order_impact_with_http_info_impl(user_id, user_secret, manual_trade_form, extra)
     end
 
-    # Check impact of trades on account.
+    # Check the impact of a trade on an account
+    # Return the trade object and it's impact on the account for the specified order.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param manual_trade_form [ManualTradeForm] 
@@ -215,7 +220,8 @@ module SnapTrade
       data
     end
 
-    # Check impact of trades on account.
+    # Check the impact of a trade on an account
+    # Return the trade object and it's impact on the account for the specified order.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param manual_trade_form [ManualTradeForm] 
@@ -406,6 +412,8 @@ module SnapTrade
 
     # Place a trade with NO validation.
     #
+    # Places a specified trade in the specified account.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -437,6 +445,8 @@ module SnapTrade
 
     # Place a trade with NO validation.
     #
+    # Places a specified trade in the specified account.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -466,6 +476,7 @@ module SnapTrade
     end
 
     # Place a trade with NO validation.
+    # Places a specified trade in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param manual_trade_form [ManualTradeForm] 
@@ -477,6 +488,7 @@ module SnapTrade
     end
 
     # Place a trade with NO validation.
+    # Places a specified trade in the specified account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param manual_trade_form [ManualTradeForm] 
@@ -548,6 +560,9 @@ module SnapTrade
 
     # Place order
     #
+    # Places the specified trade object. This places the order in the account and
+    # returns the status of the order from the brokerage.
+    #
     # @param trade_id [String] The ID of trade object obtained from trade/impact endpoint
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -564,6 +579,9 @@ module SnapTrade
 
     # Place order
     #
+    # Places the specified trade object. This places the order in the account and
+    # returns the status of the order from the brokerage.
+    #
     # @param trade_id [String] The ID of trade object obtained from trade/impact endpoint
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -578,6 +596,7 @@ module SnapTrade
     end
 
     # Place order
+    # Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage. 
     # @param trade_id [String] The ID of trade object obtained from trade/impact endpoint
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -590,6 +609,7 @@ module SnapTrade
     end
 
     # Place order
+    # Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage. 
     # @param trade_id [String] The ID of trade object obtained from trade/impact endpoint
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -87,7 +87,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_user_account_positions
   # List account positions
-  # Returns a list of positions in the the specified account.
+  # Returns a list of positions in the specified account.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get positions.

data/spec/api/connections_api_spec.rb

@@ -29,6 +29,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for detail_brokerage_authorization
   # Get brokerage authorization details
+  # Returns a single brokerage authorization object for the specified ID.
   # @param authorization_id The ID of a brokerage authorization object.
   # @param user_id 
   # @param user_secret 
@@ -41,7 +42,8 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for list_brokerage_authorizations
-  # List all brokerage authorizations for the user
+  # List all brokerage authorizations for the User
+  # Returns a list of Brokerage Authorization objects for the user
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -54,6 +56,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for remove_brokerage_authorization
   # Delete brokerage authorization
+  # Deletes a specified brokerage authorization given by the ID.
   # @param authorization_id The ID of the Authorization to delete.
   # @param user_id 
   # @param user_secret 
@@ -66,7 +69,8 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for session_events
-  # List all session events for the partner
+  # Get all session events for a user
+  # Returns a list of session events associated with a user.
   # @param partner_client_id 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users

data/spec/api/options_api_spec.rb

@@ -28,7 +28,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for get_option_strategy
-  # Creates an option strategy object that will be used to place an option strategy order
+  # Create options strategy
+  # Creates an option strategy object that will be used to place an option strategy order. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to create the option strategy object in.
@@ -42,7 +43,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for get_options_chain
-  # Get the options chain
+  # Get the options chain for a symbol
+  # Returns the option chain for the specified symbol in the specified account.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get the options chain from.
@@ -56,7 +58,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for get_options_strategy_quote
-  # Get latest market data of option strategy
+  # Get options strategy quotes
+  # Returns a Strategy Quotes object which has latest market data of the specified option strategy. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account the strategy will be placed in.
@@ -70,7 +73,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for list_option_holdings
-  # Get the options holdings in the account
+  # Get account option holdings
+  # Returns a list of Options Positions. 
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to fetch options holdings for.
@@ -83,7 +87,8 @@ describe 'OptionsApi' do
   end
 
   # unit tests for place_option_strategy
-  # Place an option strategy order on the brokerage
+  # Place an option strategy order
+  # Places the option strategy order and returns the order record received from the brokerage.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to execute the strategy in.

data/spec/api/reference_data_api_spec.rb

@@ -28,7 +28,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_currency_exchange_rate_pair
-  # Return the exchange rate of a currency pair
+  # Get exchange rate of a currency pair
+  # Returns an Exchange Rate Pair object for the specified Currency Pair.
   # @param currency_pair A currency pair based on currency code for example, {CAD-USD}
   # @param [Hash] opts the optional parameters
   # @return [ExchangeRatePairs]
@@ -61,7 +62,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_stock_exchanges
-  # List exchanges
+  # Get exchanges
+  # Returns a list of all supported Exchanges.
   # @param [Hash] opts the optional parameters
   # @return [Array<Exchange>]
   describe 'get_stock_exchanges test' do
@@ -72,6 +74,7 @@ describe 'ReferenceDataApi' do
 
   # 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. 
   # @param [Hash] opts the optional parameters
   # @option opts [SymbolQuery] :symbol_query 
   # @return [Array<UniversalSymbol>]
@@ -82,7 +85,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for get_symbols_by_ticker
-  # Get details of a symbol by the ticker or the universal_symbol_id
+  # 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.
   # @param [Hash] opts the optional parameters
   # @return [UniversalSymbol]
@@ -93,7 +97,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for list_all_brokerage_authorization_type
-  # List of all brokerage authorization types
+  # Get all brokerage authorization types
+  # Returns a list of all defined Brokerage authorization Type objects.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :brokerage Comma separated value of brokerage slugs
   # @return [Array<BrokerageAuthorizationTypeReadOnly>]
@@ -104,7 +109,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for list_all_brokerages
-  # List brokerages
+  # Get brokerages
+  # Returns a list of all defined Brokerage objects.
   # @param [Hash] opts the optional parameters
   # @return [Array<Brokerage>]
   describe 'list_all_brokerages test' do
@@ -114,7 +120,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for list_all_currencies
-  # List currencies
+  # Get currencies
+  # Returns a list of all defined Currency objects.
   # @param [Hash] opts the optional parameters
   # @return [Array<Currency>]
   describe 'list_all_currencies test' do
@@ -124,7 +131,8 @@ describe 'ReferenceDataApi' do
   end
 
   # unit tests for list_all_currencies_rates
-  # List currency exchange rates
+  # Get currency exchange rates
+  # Returns a list of all Exchange Rate Pairs for all supported Currencies.
   # @param [Hash] opts the optional parameters
   # @return [Array<ExchangeRatePairs>]
   describe 'list_all_currencies_rates test' do

data/spec/api/trading_api_spec.rb

@@ -43,7 +43,8 @@ describe 'TradingApi' do
   end
 
   # unit tests for get_order_impact
-  # Check impact of trades on account.
+  # Check the impact of a trade on an account
+  # Return the trade object and it's impact on the account for the specified order.
   # @param user_id 
   # @param user_secret 
   # @param manual_trade_form 
@@ -73,6 +74,7 @@ describe 'TradingApi' do
 
   # unit tests for place_force_order
   # Place a trade with NO validation.
+  # Places a specified trade in the specified account.
   # @param user_id 
   # @param user_secret 
   # @param manual_trade_form 
@@ -86,6 +88,7 @@ describe 'TradingApi' do
 
   # unit tests for place_order
   # Place order
+  # Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage. 
   # @param trade_id The ID of trade object obtained from trade/impact endpoint
   # @param user_id 
   # @param user_secret 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.16
+  version: 2.0.18
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday