snaptrade 1.17.10 → 2.0.77

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'
@@ -18,7 +17,10 @@ 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>] 
     # @param strategy_type [StrategyType] 
@@ -37,7 +39,10 @@ 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>] 
     # @param strategy_type [StrategyType] 
@@ -55,26 +60,28 @@ 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.
     # @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
 
-    # 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.
     # @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
@@ -142,7 +149,10 @@ 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] 
     # @param account_id [String] The ID of the account to get the options chain from.
@@ -153,7 +163,10 @@ 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.
@@ -163,26 +176,28 @@ 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.
     # @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
 
-    # 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.
     # @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
@@ -246,7 +261,10 @@ 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] 
     # @param account_id [String] The ID of the account the strategy will be placed in.
@@ -257,7 +275,10 @@ 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.
@@ -267,26 +288,28 @@ 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.
     # @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
 
-    # 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.
     # @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
@@ -349,43 +372,55 @@ module SnapTrade
     end
 
 
-    # Get the options holdings in the account
+    # List account option positions
+    #
+    # Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
+    # 
+    # The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to fetch options holdings for.
+    # @param account_id [String] 
     # @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)
       data
     end
 
-    # Get the options holdings in the account
+    # List account option positions
+    #
+    # Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
+    # 
+    # The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to fetch options holdings for.
+    # @param account_id [String] 
     # @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)
     end
 
-    # Get the options holdings in the account
+    # List account option positions
+    # Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to fetch options holdings for.
+    # @param account_id [String] 
     # @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
 
-    # Get the options holdings in the account
+    # List account option positions
+    # Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v&#x3D;d16c4c97b8d5438bbb2d8581ac53b11e) and look for \&quot;Cache Expiry Time\&quot; to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**. 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param account_id [String] The ID of the account to fetch options holdings for.
+    # @param account_id [String] 
     # @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
@@ -444,9 +479,12 @@ module SnapTrade
     end
 
 
-    # Place an option strategy order on the brokerage
-    # @param order_type [OrderType] 
-    # @param time_in_force [TimeInForce] 
+    # Place an option strategy order
+    #
+    # Places the option strategy order and returns the order record received from the brokerage.
+    #
+    # @param order_type [OrderTypeStrict] The type of order to place. - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
+    # @param time_in_force [TimeInForceStrict] The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.
@@ -464,9 +502,12 @@ module SnapTrade
       data
     end
 
-    # Place an option strategy order on the brokerage
-    # @param order_type [OrderType] 
-    # @param time_in_force [TimeInForce] 
+    # Place an option strategy order
+    #
+    # Places the option strategy order and returns the order record received from the brokerage.
+    #
+    # @param order_type [OrderTypeStrict] The type of order to place. - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required. 
+    # @param time_in_force [TimeInForceStrict] The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values: - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to execute the strategy in.
@@ -483,7 +524,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.
@@ -491,12 +533,13 @@ 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
 
-    # 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.
@@ -504,7 +547,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