snaptrade 1.17.1 → 1.17.3

data/lib/snaptrade/api/authentication_api.rb

@@ -19,6 +19,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def delete_snap_trade_user(user_id:, extra: {})
@@ -27,6 +28,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def delete_snap_trade_user_with_http_info(user_id:, extra: {})
@@ -34,6 +36,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [DeleteUserResponse]
@@ -43,6 +46,7 @@ module SnapTrade
     end
 
     # Delete SnapTrade user
+    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeleteUserResponse, Integer, Hash)>] DeleteUserResponse data, response status code and response headers
@@ -184,6 +188,7 @@ module SnapTrade
 
 
     # List SnapTrade users
+    # Returns a list of users you've registered over the SnapTrade API.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users(extra: {})
       data, _status_code, _headers = list_snap_trade_users_with_http_info_impl(extra)
@@ -191,12 +196,14 @@ module SnapTrade
     end
 
     # List SnapTrade users
+    # Returns a list of users you've registered over the SnapTrade API.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users_with_http_info(extra: {})
       list_snap_trade_users_with_http_info_impl(extra)
     end
 
     # List SnapTrade users
+    # Returns a list of users you've registered over the SnapTrade API.
     # @param [Hash] opts the optional parameters
     # @return [Array<String>]
     def list_snap_trade_users_impl(opts = {})
@@ -205,6 +212,7 @@ module SnapTrade
     end
 
     # List SnapTrade users
+    # Returns a list of users you&#39;ve registered over the SnapTrade API.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     def list_snap_trade_users_with_http_info_impl(opts = {})
@@ -253,12 +261,13 @@ module SnapTrade
 
 
     # Login user & generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] 
-    # @param immediate_redirect [Boolean] 
-    # @param custom_redirect [String] 
-    # @param reconnect [String] 
+    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
+    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected
     # @param connection_type [ConnectionType] 
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -275,12 +284,13 @@ module SnapTrade
     end
 
     # Login user & generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] 
-    # @param immediate_redirect [Boolean] 
-    # @param custom_redirect [String] 
-    # @param reconnect [String] 
+    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner&#39;s site instead of the connection portal
+    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected
     # @param connection_type [ConnectionType] 
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -296,6 +306,7 @@ module SnapTrade
     end
 
     # Login user & generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -307,6 +318,7 @@ module SnapTrade
     end
 
     # Login user &amp; generate connection link
+    # Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -374,13 +386,11 @@ module SnapTrade
 
     # Create SnapTrade user
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
-    # @param rsa_public_key [String] Open SSH RSA public key
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def register_snap_trade_user(user_id: SENTINEL, rsa_public_key: SENTINEL, extra: {})
+    def register_snap_trade_user(user_id: SENTINEL, extra: {})
       _body = {}
       _body[:userId] = user_id if user_id != SENTINEL
-      _body[:rsaPublicKey] = rsa_public_key if rsa_public_key != SENTINEL
       snap_trade_register_user_request_body = _body
       data, _status_code, _headers = register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, extra)
       data
@@ -388,13 +398,11 @@ module SnapTrade
 
     # Create SnapTrade user
     # @param user_id [String] SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it&#39;s unique to a user
-    # @param rsa_public_key [String] Open SSH RSA public key
     # @param body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def register_snap_trade_user_with_http_info(user_id: SENTINEL, rsa_public_key: SENTINEL, extra: {})
+    def register_snap_trade_user_with_http_info(user_id: SENTINEL, extra: {})
       _body = {}
       _body[:userId] = user_id if user_id != SENTINEL
-      _body[:rsaPublicKey] = rsa_public_key if rsa_public_key != SENTINEL
       snap_trade_register_user_request_body = _body
       register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, extra)
     end

data/lib/snaptrade/api/options_api.rb

@@ -24,7 +24,7 @@ module SnapTrade
     # @param strategy_type [StrategyType] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to create the option strategy object in.
     # @param body [OptionsGetOptionStrategyRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_option_strategy(underlying_symbol_id:, legs:, strategy_type:, user_id:, user_secret:, account_id:, extra: {})
@@ -43,7 +43,7 @@ module SnapTrade
     # @param strategy_type [StrategyType] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to create the option strategy object in.
     # @param body [OptionsGetOptionStrategyRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_option_strategy_with_http_info(underlying_symbol_id:, legs:, strategy_type:, user_id:, user_secret:, account_id:, extra: {})
@@ -58,7 +58,7 @@ module SnapTrade
     # 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 get positions.
+    # @param account_id [String] The ID of the account to create the option strategy object in.
     # @param options_get_option_strategy_request [OptionsGetOptionStrategyRequest] 
     # @param [Hash] opts the optional parameters
     # @return [StrategyQuotes]
@@ -70,7 +70,7 @@ module SnapTrade
     # 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 get positions.
+    # @param account_id [String] The ID of the account to create the option strategy object in.
     # @param options_get_option_strategy_request [OptionsGetOptionStrategyRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(StrategyQuotes, Integer, Hash)>] StrategyQuotes data, response status code and response headers
@@ -145,7 +145,7 @@ module SnapTrade
     # Get the options chain
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to get the options chain from.
     # @param symbol [String] Universal symbol ID if symbol
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_options_chain(user_id:, user_secret:, account_id:, symbol:, extra: {})
@@ -156,7 +156,7 @@ module SnapTrade
     # Get the options chain
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to get the options chain from.
     # @param symbol [String] Universal symbol ID if symbol
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_options_chain_with_http_info(user_id:, user_secret:, account_id:, symbol:, extra: {})
@@ -166,7 +166,7 @@ module SnapTrade
     # Get the options chain
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to get the options chain from.
     # @param symbol [String] Universal symbol ID if symbol
     # @param [Hash] opts the optional parameters
     # @return [Array<OptionChainInner>]
@@ -178,7 +178,7 @@ module SnapTrade
     # Get the options chain
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to get the options chain from.
     # @param symbol [String] Universal symbol ID if symbol
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<OptionChainInner>, Integer, Hash)>] Array<OptionChainInner> data, response status code and response headers
@@ -249,7 +249,7 @@ module SnapTrade
     # Get latest market data of option strategy
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account the strategy will be placed in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_options_strategy_quote(user_id:, user_secret:, account_id:, option_strategy_id:, extra: {})
@@ -260,7 +260,7 @@ module SnapTrade
     # Get latest market data of option strategy
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account the strategy will be placed in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_options_strategy_quote_with_http_info(user_id:, user_secret:, account_id:, option_strategy_id:, extra: {})
@@ -270,7 +270,7 @@ module SnapTrade
     # Get latest market data of option strategy
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account the strategy will be placed in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param [Hash] opts the optional parameters
     # @return [StrategyQuotes]
@@ -282,7 +282,7 @@ module SnapTrade
     # Get latest market data of option strategy
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account the strategy will be placed in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param [Hash] opts the optional parameters
     # @return [Array<(StrategyQuotes, Integer, Hash)>] StrategyQuotes data, response status code and response headers
@@ -352,7 +352,7 @@ module SnapTrade
     # Get the options holdings in the account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to fetch options holdings for.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_option_holdings(user_id:, user_secret:, account_id:, extra: {})
       data, _status_code, _headers = list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, extra)
@@ -362,7 +362,7 @@ module SnapTrade
     # Get the options holdings in the account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to fetch options holdings for.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_option_holdings_with_http_info(user_id:, user_secret:, account_id:, extra: {})
       list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, extra)
@@ -371,7 +371,7 @@ module SnapTrade
     # Get the options holdings in the account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to fetch options holdings for.
     # @param [Hash] opts the optional parameters
     # @return [Array<OptionsPosition>]
     def list_option_holdings_impl(user_id, user_secret, account_id, opts = {})
@@ -382,7 +382,7 @@ module SnapTrade
     # Get the options holdings in the account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to fetch options holdings for.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<OptionsPosition>, Integer, Hash)>] Array<OptionsPosition> data, response status code and response headers
     def list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, opts = {})
@@ -450,7 +450,7 @@ module SnapTrade
     # @param price [Float] Trade Price if limit or stop limit order
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to execute the strategy in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param body [OptionsPlaceOptionStrategyRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -470,7 +470,7 @@ module SnapTrade
     # @param price [Float] Trade Price if limit or stop limit order
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to execute the strategy in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param body [OptionsPlaceOptionStrategyRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -486,7 +486,7 @@ module SnapTrade
     # Place an option strategy order on the brokerage
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to execute the strategy in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param options_place_option_strategy_request [OptionsPlaceOptionStrategyRequest] 
     # @param [Hash] opts the optional parameters
@@ -499,7 +499,7 @@ module SnapTrade
     # Place an option strategy order on the brokerage
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to execute the strategy in.
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param options_place_option_strategy_request [OptionsPlaceOptionStrategyRequest] 
     # @param [Hash] opts the optional parameters

data/lib/snaptrade/api/reference_data_api.rb

@@ -164,20 +164,23 @@ module SnapTrade
     end
 
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_security_types(extra: {})
       data, _status_code, _headers = get_security_types_with_http_info_impl(extra)
       data
     end
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_security_types_with_http_info(extra: {})
       get_security_types_with_http_info_impl(extra)
     end
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] opts the optional parameters
     # @return [Array<SecurityType>]
     def get_security_types_impl(opts = {})
@@ -185,7 +188,8 @@ module SnapTrade
       data
     end
 
-    # List of all security types.
+    # List of all security types
+    # List security types available on SnapTrade.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<SecurityType>, Integer, Hash)>] Array<SecurityType> data, response status code and response headers
     def get_security_types_with_http_info_impl(opts = {})
@@ -758,7 +762,7 @@ module SnapTrade
     # Search for symbols available in an account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to search for symbols within.
     # @param substring [String] 
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -773,7 +777,7 @@ module SnapTrade
     # Search for symbols available in an account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to search for symbols within.
     # @param substring [String] 
     # @param body [SymbolQuery] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -787,7 +791,7 @@ module SnapTrade
     # Search for symbols available in an account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to search for symbols within.
     # @param [Hash] opts the optional parameters
     # @option opts [SymbolQuery] :symbol_query 
     # @return [Array<UniversalSymbol>]
@@ -799,7 +803,7 @@ module SnapTrade
     # Search for symbols available in an account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to search for symbols within.
     # @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

data/lib/snaptrade/api/trading_api.rb

@@ -21,7 +21,7 @@ module SnapTrade
     # Cancel open order in account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to cancel the order in.
     # @param brokerage_order_id [String] 
     # @param body [TradingCancelUserAccountOrderRequest] The Order ID to be canceled
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -36,7 +36,7 @@ module SnapTrade
     # Cancel open order in account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to cancel the order in.
     # @param brokerage_order_id [String] 
     # @param body [TradingCancelUserAccountOrderRequest] The Order ID to be canceled
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -50,7 +50,7 @@ module SnapTrade
     # Cancel open order in account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to cancel the order in.
     # @param trading_cancel_user_account_order_request [TradingCancelUserAccountOrderRequest] The Order ID to be canceled
     # @param [Hash] opts the optional parameters
     # @return [AccountOrderRecord]
@@ -62,7 +62,7 @@ module SnapTrade
     # Cancel open order in account
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account get positions.
+    # @param account_id [String] The ID of the account to cancel the order in.
     # @param trading_cancel_user_account_order_request [TradingCancelUserAccountOrderRequest] The Order ID to be canceled
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountOrderRecord, Integer, Hash)>] AccountOrderRecord data, response status code and response headers

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -19,7 +19,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -39,7 +39,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -58,7 +58,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -74,7 +74,7 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
+    # Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters