snaptrade 2.0.7 → 2.0.8

data/lib/snaptrade/api/connections_api.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'cgi'
@@ -19,6 +18,7 @@ module SnapTrade
     end
 
     # Get brokerage authorization details
+    #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -29,6 +29,7 @@ module SnapTrade
     end
 
     # Get brokerage authorization details
+    #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -43,7 +44,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [BrokerageAuthorization]
-    def detail_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
+    private def detail_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
       data, _status_code, _headers = detail_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
       data
     end
@@ -54,7 +55,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(BrokerageAuthorization, Integer, Hash)>] BrokerageAuthorization data, response status code and response headers
-    def detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
+    private def detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.detail_brokerage_authorization ...'
       end
@@ -114,6 +115,7 @@ module SnapTrade
 
 
     # List all brokerage authorizations for the user
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -123,6 +125,7 @@ module SnapTrade
     end
 
     # List all brokerage authorizations for the user
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -135,7 +138,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<BrokerageAuthorization>]
-    def list_brokerage_authorizations_impl(user_id, user_secret, opts = {})
+    private def list_brokerage_authorizations_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = list_brokerage_authorizations_with_http_info(user_id, user_secret, opts)
       data
     end
@@ -145,7 +148,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<BrokerageAuthorization>, Integer, Hash)>] Array<BrokerageAuthorization> data, response status code and response headers
-    def list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, opts = {})
+    private def list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.list_brokerage_authorizations ...'
       end
@@ -201,6 +204,7 @@ module SnapTrade
 
 
     # Delete brokerage authorization
+    #
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -211,6 +215,7 @@ module SnapTrade
     end
 
     # Delete brokerage authorization
+    #
     # @param authorization_id [String] The ID of the Authorization to delete.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -225,7 +230,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def remove_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
+    private def remove_brokerage_authorization_impl(authorization_id, user_id, user_secret, opts = {})
       remove_brokerage_authorization_with_http_info(authorization_id, user_id, user_secret, opts)
       nil
     end
@@ -236,7 +241,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
+    private def remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.remove_brokerage_authorization ...'
       end
@@ -294,6 +299,7 @@ module SnapTrade
 
 
     # List all session events for the partner
+    #
     # @param partner_client_id [String] 
     # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
     # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
@@ -306,6 +312,7 @@ module SnapTrade
     end
 
     # List all session events for the partner
+    #
     # @param partner_client_id [String] 
     # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
     # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
@@ -322,7 +329,7 @@ module SnapTrade
     # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
     # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
     # @return [Array<ConnectionsSessionEvents200ResponseInner>]
-    def session_events_impl(partner_client_id, opts = {})
+    private def session_events_impl(partner_client_id, opts = {})
       data, _status_code, _headers = session_events_with_http_info(partner_client_id, opts)
       data
     end
@@ -333,7 +340,7 @@ module SnapTrade
     # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
     # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
     # @return [Array<(Array<ConnectionsSessionEvents200ResponseInner>, Integer, Hash)>] Array<ConnectionsSessionEvents200ResponseInner> data, response status code and response headers
-    def session_events_with_http_info_impl(partner_client_id, opts = {})
+    private def session_events_with_http_info_impl(partner_client_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConnectionsApi.session_events ...'
       end

data/lib/snaptrade/api/error_logs_api.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'cgi'
@@ -19,6 +18,7 @@ module SnapTrade
     end
 
     # Retrieve error logs on behalf of your SnapTrade users
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -28,6 +28,7 @@ module SnapTrade
     end
 
     # Retrieve error logs on behalf of your SnapTrade users
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -40,7 +41,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<UserErrorLog>]
-    def list_user_errors_impl(user_id, user_secret, opts = {})
+    private def list_user_errors_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = list_user_errors_with_http_info(user_id, user_secret, opts)
       data
     end
@@ -50,7 +51,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<UserErrorLog>, Integer, Hash)>] Array<UserErrorLog> data, response status code and response headers
-    def list_user_errors_with_http_info_impl(user_id, user_secret, opts = {})
+    private def list_user_errors_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ErrorLogsApi.list_user_errors ...'
       end

data/lib/snaptrade/api/options_api.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'cgi'
@@ -19,6 +18,7 @@ module SnapTrade
     end
 
     # Creates an option strategy object that will be used to place an option strategy order
+    #
     # @param underlying_symbol_id [String] 
     # @param legs [Array<OptionLeg>] 
     # @param strategy_type [StrategyType] 
@@ -38,6 +38,7 @@ module SnapTrade
     end
 
     # Creates an option strategy object that will be used to place an option strategy order
+    #
     # @param underlying_symbol_id [String] 
     # @param legs [Array<OptionLeg>] 
     # @param strategy_type [StrategyType] 
@@ -62,7 +63,7 @@ module SnapTrade
     # @param options_get_option_strategy_request [OptionsGetOptionStrategyRequest] 
     # @param [Hash] opts the optional parameters
     # @return [StrategyQuotes]
-    def get_option_strategy_impl(user_id, user_secret, account_id, options_get_option_strategy_request, opts = {})
+    private def get_option_strategy_impl(user_id, user_secret, account_id, options_get_option_strategy_request, opts = {})
       data, _status_code, _headers = get_option_strategy_with_http_info(user_id, user_secret, account_id, options_get_option_strategy_request, opts)
       data
     end
@@ -74,7 +75,7 @@ module SnapTrade
     # @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
-    def get_option_strategy_with_http_info_impl(user_id, user_secret, account_id, options_get_option_strategy_request, opts = {})
+    private def get_option_strategy_with_http_info_impl(user_id, user_secret, account_id, options_get_option_strategy_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.get_option_strategy ...'
       end
@@ -143,6 +144,7 @@ module SnapTrade
 
 
     # Get the options chain
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get the options chain from.
@@ -154,6 +156,7 @@ module SnapTrade
     end
 
     # Get the options chain
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get the options chain from.
@@ -170,7 +173,7 @@ module SnapTrade
     # @param symbol [String] Universal symbol ID if symbol
     # @param [Hash] opts the optional parameters
     # @return [Array<OptionChainInner>]
-    def get_options_chain_impl(user_id, user_secret, account_id, symbol, opts = {})
+    private def get_options_chain_impl(user_id, user_secret, account_id, symbol, opts = {})
       data, _status_code, _headers = get_options_chain_with_http_info(user_id, user_secret, account_id, symbol, opts)
       data
     end
@@ -182,7 +185,7 @@ module SnapTrade
     # @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
-    def get_options_chain_with_http_info_impl(user_id, user_secret, account_id, symbol, opts = {})
+    private def get_options_chain_with_http_info_impl(user_id, user_secret, account_id, symbol, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.get_options_chain ...'
       end
@@ -247,6 +250,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 the strategy will be placed in.
@@ -258,6 +262,7 @@ module SnapTrade
     end
 
     # Get latest market data of 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.
@@ -274,7 +279,7 @@ module SnapTrade
     # @param option_strategy_id [String] Option strategy id obtained from response when creating option strategy object
     # @param [Hash] opts the optional parameters
     # @return [StrategyQuotes]
-    def get_options_strategy_quote_impl(user_id, user_secret, account_id, option_strategy_id, opts = {})
+    private def get_options_strategy_quote_impl(user_id, user_secret, account_id, option_strategy_id, opts = {})
       data, _status_code, _headers = get_options_strategy_quote_with_http_info(user_id, user_secret, account_id, option_strategy_id, opts)
       data
     end
@@ -286,7 +291,7 @@ module SnapTrade
     # @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
-    def get_options_strategy_quote_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, opts = {})
+    private def get_options_strategy_quote_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.get_options_strategy_quote ...'
       end
@@ -350,6 +355,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 to fetch options holdings for.
@@ -360,6 +366,7 @@ module SnapTrade
     end
 
     # Get the options holdings in the account
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to fetch options holdings for.
@@ -374,7 +381,7 @@ module SnapTrade
     # @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 = {})
+    private def list_option_holdings_impl(user_id, user_secret, account_id, opts = {})
       data, _status_code, _headers = list_option_holdings_with_http_info(user_id, user_secret, account_id, opts)
       data
     end
@@ -385,7 +392,7 @@ module SnapTrade
     # @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 = {})
+    private def list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.list_option_holdings ...'
       end
@@ -445,8 +452,9 @@ module SnapTrade
 
 
     # Place an option strategy order on the brokerage
-    # @param order_type [OrderType] 
-    # @param time_in_force [TimeInForceStrict] 
+    #
+    # @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 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.
@@ -465,8 +473,9 @@ module SnapTrade
     end
 
     # Place an option strategy order on the brokerage
-    # @param order_type [OrderType] 
-    # @param time_in_force [TimeInForceStrict] 
+    #
+    # @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 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.
@@ -491,7 +500,7 @@ module SnapTrade
     # @param options_place_option_strategy_request [OptionsPlaceOptionStrategyRequest] 
     # @param [Hash] opts the optional parameters
     # @return [StrategyOrderRecord]
-    def place_option_strategy_impl(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, opts = {})
+    private def place_option_strategy_impl(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, opts = {})
       data, _status_code, _headers = place_option_strategy_with_http_info(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, opts)
       data
     end
@@ -504,7 +513,7 @@ module SnapTrade
     # @param options_place_option_strategy_request [OptionsPlaceOptionStrategyRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(StrategyOrderRecord, Integer, Hash)>] StrategyOrderRecord data, response status code and response headers
-    def place_option_strategy_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, opts = {})
+    private def place_option_strategy_with_http_info_impl(user_id, user_secret, account_id, option_strategy_id, options_place_option_strategy_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.place_option_strategy ...'
       end