snaptrade 1.17.1 → 1.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11e9f2aea1f755578213104aa1cc126b653d6292c05c7e3e6288bebcfc8da73b
-  data.tar.gz: b0940810de615ff56c4ef53edb152743c36b48d7a9e1a6ba9f7d2d242322a80c
+  metadata.gz: 9cb2560186a962f93599e524293007f29c92ac375304bd228b20ee2d8d865ffe
+  data.tar.gz: 02fb0326a264c8e70dc8fde4b4928b836da876498ac29ead5851550c517ec2ca
 SHA512:
-  metadata.gz: 88953372bdf7e1b38de4a9e3bfdffe2b3cebdd3967afc8f60292fc5ab451ab79429c16dbbbbdae0eb378acded553ffb3551149fa078416ed1cc128bb9a0dd1d8
-  data.tar.gz: ea4851e753695c173cbb9a9779334d3137b38c676388358d82015961c4d7d2852c7debf02cf33f24c1b801b0c8e9230c7742c780c2e2c9785bb3652b96040cbe
+  metadata.gz: 9199a3e0a885f87e9e57433a89464d69ea5053182b1e789a7605b5523d9afe94503b1e0832ed279f5d1a5a923a6ba44d6bfc570ef7569274b6b8e0c5fef776fb
+  data.tar.gz: 3bf20e964ee5ed6b875f1be424c9a2b5293a7c74eceeb7c3443edd48fa0107003d46c7f2af9a1f63a969dd89fd0b11021301ccf7cfc61c1e1db89e469f69ab63

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (1.17.0)
+    snaptrade (1.17.1)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 1.17.1'
+gem 'snaptrade', '~> 1.17.2'
 ```
 
 ## Getting Started

data/docs/AccountInformationApi.md

@@ -137,7 +137,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to get balances. |  |
 
 ### Return type
 
@@ -271,7 +271,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to get orders. |  |
 | **state** | **String** | defaults value is set to \"all\" | [optional] |
 
 ### Return type
@@ -337,7 +337,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to get positions. |  |
 
 ### Return type
 

data/docs/OptionsApi.md

@@ -93,7 +93,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to create the option strategy object in. |  |
 | **options_get_option_strategy_request** | [**OptionsGetOptionStrategyRequest**](OptionsGetOptionStrategyRequest.md) |  |  |
 
 ### Return type
@@ -163,7 +163,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to get the options chain from. |  |
 | **symbol** | **String** | Universal symbol ID if symbol |  |
 
 ### Return type
@@ -233,7 +233,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account the strategy will be placed in. |  |
 | **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object |  |
 
 ### Return type
@@ -299,7 +299,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to fetch options holdings for. |  |
 
 ### Return type
 
@@ -380,7 +380,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to execute the strategy in. |  |
 | **option_strategy_id** | **String** | Option strategy id obtained from response when creating option strategy object |  |
 | **options_place_option_strategy_request** | [**OptionsPlaceOptionStrategyRequest**](OptionsPlaceOptionStrategyRequest.md) |  |  |
 

data/docs/OptionsPosition.md

@@ -9,8 +9,6 @@
 | **units** | **Float** |  | [optional] |
 | **currency** | [**OptionsPositionCurrency**](OptionsPositionCurrency.md) |  | [optional] |
 | **average_purchase_price** | **Float** | Average purchase price for this position | [optional] |
-| **open_pnl** | **Float** |  | [optional] |
-| **fractional_units** | **Float** | Deprecated, use the units field for both fractional and integer units going forward | [optional] |
 
 ## Example
 
@@ -22,9 +20,7 @@ instance = SnapTrade::OptionsPosition.new(
   price: 31.33,
   units: 10,
   currency: null,
-  average_purchase_price: 108.3353,
-  open_pnl: 0.44,
-  fractional_units: 1.44
+  average_purchase_price: 108.3353
 )
 ```
 

data/docs/ReferenceDataApi.md

@@ -586,7 +586,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to search for symbols within. |  |
 | **symbol_query** | [**SymbolQuery**](SymbolQuery.md) |  | [optional] |
 
 ### Return type

data/docs/TradingApi.md

@@ -74,7 +74,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **user_id** | **String** |  |  |
 | **user_secret** | **String** |  |  |
-| **account_id** | **String** | The ID of the account get positions. |  |
+| **account_id** | **String** | The ID of the account to cancel the order in. |  |
 | **trading_cancel_user_account_order_request** | [**TradingCancelUserAccountOrderRequest**](TradingCancelUserAccountOrderRequest.md) | The Order ID to be canceled |  |
 
 ### Return type

data/lib/snaptrade/api/account_information_api.rb

@@ -115,7 +115,7 @@ module SnapTrade
     # List account balances
     # @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 balances.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_balance(user_id:, user_secret:, account_id:, extra: {})
       data, _status_code, _headers = get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
@@ -125,7 +125,7 @@ module SnapTrade
     # List account balances
     # @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 balances.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_balance_with_http_info(user_id:, user_secret:, account_id:, extra: {})
       get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, extra)
@@ -134,7 +134,7 @@ module SnapTrade
     # List account balances
     # @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 balances.
     # @param [Hash] opts the optional parameters
     # @return [Array<Balance>]
     def get_user_account_balance_impl(user_id, user_secret, account_id, opts = {})
@@ -145,7 +145,7 @@ module SnapTrade
     # List account balances
     # @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 balances.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Balance>, Integer, Hash)>] Array<Balance> data, response status code and response headers
     def get_user_account_balance_with_http_info_impl(user_id, user_secret, account_id, opts = {})
@@ -305,7 +305,7 @@ module SnapTrade
     # Get history of orders placed 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 get orders.
     # @param state [String] defaults value is set to \&quot;all\&quot;
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_orders(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
@@ -317,7 +317,7 @@ module SnapTrade
     # Get history of orders placed 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 get orders.
     # @param state [String] defaults value is set to \&quot;all\&quot;
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_orders_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
@@ -328,7 +328,7 @@ module SnapTrade
     # Get history of orders placed 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 get orders.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state defaults value is set to \&quot;all\&quot;
     # @return [Array<AccountOrderRecord>]
@@ -340,7 +340,7 @@ module SnapTrade
     # Get history of orders placed 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 get orders.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state defaults value is set to \&quot;all\&quot;
     # @return [Array<(Array<AccountOrderRecord>, Integer, Hash)>] Array<AccountOrderRecord> data, response status code and response headers
@@ -411,7 +411,7 @@ module SnapTrade
     # List account positions
     # @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 positions.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_positions(user_id:, user_secret:, account_id:, extra: {})
       data, _status_code, _headers = get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
@@ -421,7 +421,7 @@ module SnapTrade
     # List account positions
     # @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 positions.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_user_account_positions_with_http_info(user_id:, user_secret:, account_id:, extra: {})
       get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, extra)
@@ -430,7 +430,7 @@ module SnapTrade
     # List account positions
     # @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 positions.
     # @param [Hash] opts the optional parameters
     # @return [Array<Position>]
     def get_user_account_positions_impl(user_id, user_secret, account_id, opts = {})
@@ -441,7 +441,7 @@ module SnapTrade
     # List account positions
     # @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 positions.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Position>, Integer, Hash)>] Array<Position> data, response status code and response headers
     def get_user_account_positions_with_http_info_impl(user_id, user_secret, account_id, opts = {})

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

@@ -758,7 +758,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 +773,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 +787,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 +799,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/models/options_position.rb

@@ -26,11 +26,6 @@ module SnapTrade
     # Average purchase price for this position
     attr_accessor :average_purchase_price
 
-    attr_accessor :open_pnl
-
-    # Deprecated, use the units field for both fractional and integer units going forward
-    attr_accessor :fractional_units
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,9 +33,7 @@ module SnapTrade
         :'price' => :'price',
         :'units' => :'units',
         :'currency' => :'currency',
-        :'average_purchase_price' => :'average_purchase_price',
-        :'open_pnl' => :'open_pnl',
-        :'fractional_units' => :'fractional_units'
+        :'average_purchase_price' => :'average_purchase_price'
       }
     end
 
@@ -56,9 +49,7 @@ module SnapTrade
         :'price' => :'Float',
         :'units' => :'Float',
         :'currency' => :'OptionsPositionCurrency',
-        :'average_purchase_price' => :'Float',
-        :'open_pnl' => :'Float',
-        :'fractional_units' => :'Float'
+        :'average_purchase_price' => :'Float'
       }
     end
 
@@ -67,9 +58,7 @@ module SnapTrade
       Set.new([
         :'price',
         :'currency',
-        :'average_purchase_price',
-        :'open_pnl',
-        :'fractional_units'
+        :'average_purchase_price'
       ])
     end
 
@@ -107,14 +96,6 @@ module SnapTrade
       if attributes.key?(:'average_purchase_price')
         self.average_purchase_price = attributes[:'average_purchase_price']
       end
-
-      if attributes.key?(:'open_pnl')
-        self.open_pnl = attributes[:'open_pnl']
-      end
-
-      if attributes.key?(:'fractional_units')
-        self.fractional_units = attributes[:'fractional_units']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -139,9 +120,7 @@ module SnapTrade
           price == o.price &&
           units == o.units &&
           currency == o.currency &&
-          average_purchase_price == o.average_purchase_price &&
-          open_pnl == o.open_pnl &&
-          fractional_units == o.fractional_units
+          average_purchase_price == o.average_purchase_price
     end
 
     # @see the `==` method
@@ -153,7 +132,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [symbol, price, units, currency, average_purchase_price, open_pnl, fractional_units].hash
+      [symbol, price, units, currency, average_purchase_price].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/version.rb

@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '1.17.1'
+  VERSION = '1.17.2'
 end

data/spec/api/account_information_api_spec.rb

@@ -45,7 +45,7 @@ describe 'AccountInformationApi' do
   # List account balances
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get balances.
   # @param [Hash] opts the optional parameters
   # @return [Array<Balance>]
   describe 'get_user_account_balance test' do
@@ -71,7 +71,7 @@ describe 'AccountInformationApi' do
   # Get history of orders placed in account
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get orders.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :state defaults value is set to \&quot;all\&quot;
   # @return [Array<AccountOrderRecord>]
@@ -85,7 +85,7 @@ describe 'AccountInformationApi' do
   # List account positions
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get positions.
   # @param [Hash] opts the optional parameters
   # @return [Array<Position>]
   describe 'get_user_account_positions test' do

data/spec/api/options_api_spec.rb

@@ -32,7 +32,7 @@ describe 'OptionsApi' do
   # 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 get positions.
+  # @param account_id The ID of the account to create the option strategy object in.
   # @param options_get_option_strategy_request 
   # @param [Hash] opts the optional parameters
   # @return [StrategyQuotes]
@@ -46,7 +46,7 @@ describe 'OptionsApi' do
   # Get the options chain
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to get the options chain from.
   # @param symbol Universal symbol ID if symbol
   # @param [Hash] opts the optional parameters
   # @return [Array<OptionChainInner>]
@@ -60,7 +60,7 @@ describe 'OptionsApi' do
   # Get latest market data of option strategy
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account the strategy will be placed in.
   # @param option_strategy_id Option strategy id obtained from response when creating option strategy object
   # @param [Hash] opts the optional parameters
   # @return [StrategyQuotes]
@@ -74,7 +74,7 @@ describe 'OptionsApi' do
   # Get the options holdings in the account
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to fetch options holdings for.
   # @param [Hash] opts the optional parameters
   # @return [Array<OptionsPosition>]
   describe 'list_option_holdings test' do
@@ -87,7 +87,7 @@ describe 'OptionsApi' do
   # Place an option strategy order on the brokerage
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to execute the strategy in.
   # @param option_strategy_id Option strategy id obtained from response when creating option strategy object
   # @param options_place_option_strategy_request 
   # @param [Hash] opts the optional parameters

data/spec/api/reference_data_api_spec.rb

@@ -137,7 +137,7 @@ describe 'ReferenceDataApi' do
   # Search for symbols available in an account
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to search for symbols within.
   # @param [Hash] opts the optional parameters
   # @option opts [SymbolQuery] :symbol_query 
   # @return [Array<UniversalSymbol>]

data/spec/api/trading_api_spec.rb

@@ -32,7 +32,7 @@ describe 'TradingApi' do
   # Cancel open order in account
   # @param user_id 
   # @param user_secret 
-  # @param account_id The ID of the account get positions.
+  # @param account_id The ID of the account to cancel the order in.
   # @param trading_cancel_user_account_order_request The Order ID to be canceled
   # @param [Hash] opts the optional parameters
   # @return [AccountOrderRecord]

data/spec/models/options_position_spec.rb

@@ -51,16 +51,4 @@ describe SnapTrade::OptionsPosition do
     end
   end
 
-  describe 'test attribute "open_pnl"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "fractional_units"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 1.17.2
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday