snaptrade 2.0.29 → 2.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eda55725a9b97295f947e385aaa5003b02a7d20e8e4603cefa5a17dbdf27215d
-  data.tar.gz: f03cb7a20b125bb83a122fa42ab9948891583bb8f4888d365ec225e51f1220a1
+  metadata.gz: 4473f0d7f5cc9ca2466287af5c01b2d7eb3a32f20bb08407b5192c4f43d1bde5
+  data.tar.gz: 95e42f51f88e79ccc23e880f96075ff27904bacaf355b31ab2ed656d7a3c11b7
 SHA512:
-  metadata.gz: dec55a480470054f6c039189d796edf016ff838ab276afa435c2b8f6fd7df6c94687ca474af52311a16c2a039a819043e938fbb228be751d67ccae77ec145590
-  data.tar.gz: 7213d617ae5118e8f7b313bbafa49446e17134c7b5fefc961626cdab60f28e61844bc8345fb40b8b77a2794aabf88b8102df9c2cb3afa1d4ffbc7d854fb35800
+  metadata.gz: 4a9684055202d8e628a2411cb281e854e54ee10a129b382eccccce0319357b8df46240646466406d57a2e9d0704406f177b453e85f2d416b3a63c1ee84b76fbe
+  data.tar.gz: a8f50d47809964ba63c21f15ce16f5265495973ceced0c85fb1fae94a85c8b6605ed7b86f5df5b370e76f7b77a57c54606e354e53058a21a9293d0ff227eb55c

data/Gemfile.lock

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

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.29-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.29)
+[![npm](https://img.shields.io/badge/gem-v2.0.31-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.31)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.29'
+gem 'snaptrade', '~> 2.0.31'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -112,8 +112,10 @@ p.result[3] # [Faraday::Response] Raw HTTP response
 ### `snaptrade.account_information.get_all_user_holdings`<a id="snaptradeaccount_informationget_all_user_holdings"></a>
 ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
-Lists balances, positions and orders for the specified account. The data returned is similar to
-the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+**Deprecated, please use the account-specific holdings endpoint instead.**
+
+List all accounts for the user, plus balances, positions, and orders for each
+account.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -301,9 +303,7 @@ The ID of the account to get positions.
 
 ### `snaptrade.account_information.get_user_holdings`<a id="snaptradeaccount_informationget_user_holdings"></a>
 
-Lists balances, positions and orders for the specified account as well as
-option_positions and account metadata. The data returned is similar to the
-data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -320,8 +320,6 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to fetch holdings for.
-
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -501,7 +499,9 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### broker: `String`<a id="broker-string"></a>
-Slug of the brokerage to connect the user to
+Slug of the brokerage to connect the user to. See [this
+document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead)
+for a list of supported brokerages and their slugs.
 
 ##### immediateRedirect: `Boolean`<a id="immediateredirect-boolean"></a>
 When set to True, user will be redirected back to the partner's site instead of
@@ -519,7 +519,7 @@ Accounts’ for more information.
 Sets whether the connection should be read or trade
 
 ##### connectionPortalVersion: [`ConnectionPortalVersion`](./lib/snaptrade/models/connection_portal_version.rb)<a id="connectionportalversion-connectionportalversionlibsnaptrademodelsconnection_portal_versionrb"></a>
-Sets the version of the connection portal to render, with a default to 'v2'
+Sets the version of the connection portal to render, with a default to 'v3'
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -536,8 +536,8 @@ Sets the version of the connection portal to render, with a default to 'v2'
 
 ### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
 
-Registers a new SnapTrade user under your ClientID.
-Most SnapTrade operations require a user to be passed as a parameter.
+Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
+Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -714,7 +714,7 @@ p result
 
 ### `snaptrade.connections.refresh_brokerage_authorization`<a id="snaptradeconnectionsrefresh_brokerage_authorization"></a>
 
-Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1441,7 +1441,7 @@ Canceled
 
 ### `snaptrade.trading.get_user_account_quotes`<a id="snaptradetradingget_user_account_quotes"></a>
 
-Returns live quote(s) from the brokerage for the specified symbol(s).
+Returns quote(s) from the brokerage for the specified symbol(s).
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

data/lib/snaptrade/api/account_information_api.rb

@@ -19,8 +19,10 @@ module SnapTrade
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
     #
-    # Lists balances, positions and orders for the specified account. The data returned is similar to
-    # the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    # **Deprecated, please use the account-specific holdings endpoint instead.**
+    # 
+    # List all accounts for the user, plus balances, positions, and orders for each
+    # account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -34,8 +36,10 @@ module SnapTrade
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
     #
-    # Lists balances, positions and orders for the specified account. The data returned is similar to
-    # the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    # **Deprecated, please use the account-specific holdings endpoint instead.**
+    # 
+    # List all accounts for the user, plus balances, positions, and orders for each
+    # account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -47,7 +51,7 @@ module SnapTrade
     end
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
-    # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
+    # **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -59,7 +63,7 @@ module SnapTrade
     end
 
     # List all accounts for the user, plus balances, positions, and orders for each account.
-    # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
+    # **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -557,13 +561,11 @@ module SnapTrade
     end
 
 
-    # List balances, positions and orders for the specified account
+    # List account holdings
     #
-    # Lists balances, positions and orders for the specified account as well as
-    # option_positions and account metadata. The data returned is similar to the
-    # data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
     #
-    # @param account_id [String] The ID of the account to fetch holdings for.
+    # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -572,13 +574,11 @@ module SnapTrade
       data
     end
 
-    # List balances, positions and orders for the specified account
+    # List account holdings
     #
-    # Lists balances, positions and orders for the specified account as well as
-    # option_positions and account metadata. The data returned is similar to the
-    # data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
+    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
     #
-    # @param account_id [String] The ID of the account to fetch holdings for.
+    # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -586,9 +586,9 @@ module SnapTrade
       get_user_holdings_with_http_info_impl(account_id, user_id, user_secret, extra)
     end
 
-    # List balances, positions and orders for the specified account
-    # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
-    # @param account_id [String] The ID of the account to fetch holdings for.
+    # List account holdings
+    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 
+    # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -598,9 +598,9 @@ module SnapTrade
       data
     end
 
-    # List balances, positions and orders for the specified account
-    # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
-    # @param account_id [String] The ID of the account to fetch holdings for.
+    # List account holdings
+    # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 
+    # @param account_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters

data/lib/snaptrade/api/authentication_api.rb

@@ -186,12 +186,12 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param broker [String] Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
     # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner'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. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
     # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
-    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v2'
+    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v3'
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
@@ -213,12 +213,12 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] Slug of the brokerage to connect the user to
+    # @param broker [String] Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
     # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner'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. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
     # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
-    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v2'
+    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v3'
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
@@ -314,8 +314,8 @@ module SnapTrade
 
     # Create SnapTrade user
     #
-    # Registers a new SnapTrade user under your ClientID.
-    # Most SnapTrade operations require a user to be passed as a parameter.
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
+    # Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
     #
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
@@ -330,8 +330,8 @@ module SnapTrade
 
     # Create SnapTrade user
     #
-    # Registers a new SnapTrade user under your ClientID.
-    # Most SnapTrade operations require a user to be passed as a parameter.
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
+    # Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
     #
     # @param user_id [String] SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
     # @param body [SnapTradeRegisterUserRequestBody] 
@@ -344,7 +344,7 @@ module SnapTrade
     end
 
     # Create SnapTrade user
-    # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter. 
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -354,7 +354,7 @@ module SnapTrade
     end
 
     # Create SnapTrade user
-    # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter. 
+    # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers

data/lib/snaptrade/api/connections_api.rb

@@ -320,7 +320,7 @@ module SnapTrade
 
     # Refresh holdings for a connection
     #
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
@@ -333,7 +333,7 @@ module SnapTrade
 
     # Refresh holdings for a connection
     #
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     #
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
@@ -344,7 +344,7 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -356,7 +356,7 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
     # @param authorization_id [String] The ID of a brokerage authorization object.
     # @param user_id [String] 
     # @param user_secret [String] 

data/lib/snaptrade/api/trading_api.rb

@@ -293,7 +293,7 @@ module SnapTrade
 
     # Get symbol quotes
     #
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -309,7 +309,7 @@ module SnapTrade
 
     # Get symbol quotes
     #
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -323,7 +323,7 @@ module SnapTrade
     end
 
     # Get symbol quotes
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param symbols [String] List of universal_symbol_id or tickers to get quotes for.
@@ -337,7 +337,7 @@ module SnapTrade
     end
 
     # Get symbol quotes
-    # Returns live quote(s) from the brokerage for the specified symbol(s).
+    # Returns quote(s) from the brokerage for the specified symbol(s).
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param symbols [String] List of universal_symbol_id or tickers to get quotes for.

data/lib/snaptrade/models/account_balance.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Balance of the account
+  # Contains balance related information for the account.
   class AccountBalance
     attr_accessor :total
 

data/lib/snaptrade/models/account_balance_total.rb

@@ -13,8 +13,10 @@ require 'time'
 module SnapTrade
   # Total value of this account (includes cash, equity, fixed income, etc)
   class AccountBalanceTotal
+    # Total value denominated in the currency of the `currency` field.
     attr_accessor :amount
 
+    # The ISO-4217 currency code for the amount.
     attr_accessor :currency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/account_holdings_account.rb

@@ -11,16 +11,20 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Account Holdings with Account ID
+  # A wrapper object containing holdings information for a single account
   class AccountHoldingsAccount
     attr_accessor :account
 
+    # List of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
     attr_accessor :balances
 
+    # List of stock/ETF/crypto/mutual fund positions in the account.
     attr_accessor :positions
 
+    # List of option positions in the account.
     attr_accessor :option_positions
 
+    # List of recent orders in the account, including both pending and executed orders.
     attr_accessor :orders
 
     attr_accessor :total_value

data/lib/snaptrade/models/amount.rb

@@ -13,8 +13,10 @@ require 'time'
 module SnapTrade
   # Total value of the account, as reported by the brokerage
   class Amount
+    # Total value denominated in the currency of the `currency` field.
     attr_accessor :amount
 
+    # The ISO-4217 currency code for the amount.
     attr_accessor :currency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/balance.rb

@@ -11,12 +11,14 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Account Balance
+  # Holds balance information for a single currency in an account.
   class Balance
     attr_accessor :currency
 
+    # The amount of available cash in the account denominated in the currency of the `currency` field.
     attr_accessor :cash
 
+    # Buying power only applies to margin accounts. For non-margin accounts, buying power should be the same as cash. Please note that this field is not always available for all brokerages.
     attr_accessor :buying_power
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/currency.rb

@@ -11,12 +11,15 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Currency
+  # Describes a currency object.
   class Currency
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
     attr_accessor :id
 
+    # The ISO-4217 currency code for the currency.
     attr_accessor :code
 
+    # A human-friendly name of the currency.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/options_position.rb

@@ -11,18 +11,19 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Option Holdings
+  # Describes a single option position in an account.
   class OptionsPosition
     attr_accessor :symbol
 
-    # Trade Price if limit or stop limit order
+    # Last known market price for the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
     attr_accessor :price
 
+    # The number of contracts for this option position.
     attr_accessor :units
 
     attr_accessor :currency
 
-    # Average purchase price for this position
+    # Cost basis _per contract_ of this option position. To get the cost basis _per share_, divide this value by the number of shares per contract (usually 100).
     attr_accessor :average_purchase_price
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/options_position_currency.rb

@@ -12,10 +12,13 @@ require 'time'
 
 module SnapTrade
   class OptionsPositionCurrency
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
     attr_accessor :id
 
+    # The ISO-4217 currency code for the currency.
     attr_accessor :code
 
+    # A human-friendly name of the currency.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/position.rb

@@ -11,21 +11,23 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Account Position
+  # Describes a single stock/ETF/crypto/mutual fund position in an account.
   class Position
     attr_accessor :symbol
 
+    # The number of shares of the position. This can be fractional or integer units.
     attr_accessor :units
 
-    # Last known market price for the symbol
+    # Last known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
     attr_accessor :price
 
+    # The profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field.
     attr_accessor :open_pnl
 
-    # Deprecated, use the units field for both fractional and integer units going forward
+    # Deprecated, use the `units` field for both fractional and integer units going forward
     attr_accessor :fractional_units
 
-    # Average purchase price for this position. Either returned by the underlying broker or calculated using historical transactions.
+    # Cost basis _per share_ of this position.
     attr_accessor :average_purchase_price
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/snap_trade_holdings_account_account_id.rb

@@ -11,27 +11,35 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Holdings with account ID
+  # A single brokerage account at a financial institution.
   class SnapTradeHoldingsAccountAccountId
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :id
 
+    # Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
     attr_accessor :brokerage_authorization
 
+    # Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
     attr_accessor :portfolio_group
 
+    # A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
     attr_accessor :name
 
+    # The account number assigned by the financial institution.
     attr_accessor :number
 
+    # The name of the financial institution that holds the account.
     attr_accessor :institution_name
 
     attr_accessor :balance
 
+    # Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there's no standard format for this data. Please use at your own risk.
     attr_accessor :meta
 
+    # This field is deprecated.
     attr_accessor :cash_restrictions
 
-    # Time
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the financial institution.
     attr_accessor :created_date
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -67,7 +75,7 @@ module SnapTrade
         :'balance' => :'SnapTradeHoldingsAccountAccountIdBalance',
         :'meta' => :'Hash<String, Object>',
         :'cash_restrictions' => :'Array<CashRestriction>',
-        :'created_date' => :'String'
+        :'created_date' => :'Time'
       }
     end
 

data/lib/snaptrade/models/snap_trade_holdings_total_value.rb

@@ -11,10 +11,12 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Calculated based on the sum of the values of account positions and cash balances
+  # The total market value of the account. Note that this field is calculated based on the sum of the values of account positions and cash balances known to SnapTrade. It may not be accurate if the brokerage account has holdings that SnapTrade is not aware of. For example, if the brokerage account holds assets that SnapTrade does not support, the total value may be underreported. To get the brokerage reported total market value of the account, refer to `account.balance.total`.
   class SnapTradeHoldingsTotalValue
+    # Total value denominated in the currency of the `currency` field.
     attr_accessor :value
 
+    # The ISO-4217 currency code for the amount.
     attr_accessor :currency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/models/snap_trade_login_user_request_body.rb

@@ -13,7 +13,7 @@ require 'time'
 module SnapTrade
   # Data to login a user via SnapTrade Partner
   class SnapTradeLoginUserRequestBody
-    # Slug of the brokerage to connect the user to
+    # Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
     attr_accessor :broker
 
     # When set to True, user will be redirected back to the partner's site instead of the connection portal
@@ -28,7 +28,7 @@ module SnapTrade
     # Sets whether the connection should be read or trade
     attr_accessor :connection_type
 
-    # Sets the version of the connection portal to render, with a default to 'v2'
+    # Sets the version of the connection portal to render, with a default to 'v3'
     attr_accessor :connection_portal_version
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -96,7 +96,6 @@ require 'snaptrade/models/option_strategy'
 require 'snaptrade/models/option_strategy_legs_inner'
 require 'snaptrade/models/option_type'
 require 'snaptrade/models/options_get_option_strategy_request'
-require 'snaptrade/models/options_holdings'
 require 'snaptrade/models/options_place_option_strategy_request'
 require 'snaptrade/models/options_position'
 require 'snaptrade/models/options_position_currency'

data/spec/api/account_information_api_spec.rb

@@ -29,7 +29,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_all_user_holdings
   # List all accounts for the user, plus balances, positions, and orders for each account.
-  # Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
+  # **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account. 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -100,9 +100,9 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_holdings
-  # List balances, positions and orders for the specified account
-  # Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints. 
-  # @param account_id The ID of the account to fetch holdings for.
+  # List account holdings
+  # Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ 
+  # @param account_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/api/authentication_api_spec.rb

@@ -66,7 +66,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for register_snap_trade_user
   # Create SnapTrade user
-  # Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter. 
+  # Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter. 
   # @param snap_trade_register_user_request_body 
   # @param [Hash] opts the optional parameters
   # @return [UserIDandSecret]

data/spec/api/connections_api_spec.rb

@@ -70,7 +70,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for refresh_brokerage_authorization
   # Refresh holdings for a connection
-  # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
+  # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
   # @param authorization_id The ID of a brokerage authorization object.
   # @param user_id 
   # @param user_secret 

data/spec/api/trading_api_spec.rb

@@ -58,7 +58,7 @@ describe 'TradingApi' do
 
   # unit tests for get_user_account_quotes
   # Get symbol quotes
-  # Returns live quote(s) from the brokerage for the specified symbol(s).
+  # Returns quote(s) from the brokerage for the specified symbol(s).
   # @param user_id 
   # @param user_secret 
   # @param symbols List of universal_symbol_id or tickers to get quotes for.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.29
+  version: 2.0.31
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -175,7 +175,6 @@ files:
 - lib/snaptrade/models/option_strategy_legs_inner.rb
 - lib/snaptrade/models/option_type.rb
 - lib/snaptrade/models/options_get_option_strategy_request.rb
-- lib/snaptrade/models/options_holdings.rb
 - lib/snaptrade/models/options_place_option_strategy_request.rb
 - lib/snaptrade/models/options_position.rb
 - lib/snaptrade/models/options_position_currency.rb
@@ -329,7 +328,6 @@ files:
 - spec/models/option_strategy_spec.rb
 - spec/models/option_type_spec.rb
 - spec/models/options_get_option_strategy_request_spec.rb
-- spec/models/options_holdings_spec.rb
 - spec/models/options_place_option_strategy_request_spec.rb
 - spec/models/options_position_currency_spec.rb
 - spec/models/options_position_spec.rb
@@ -494,7 +492,6 @@ test_files:
 - spec/models/strategy_order_place_orders_inner_spec.rb
 - spec/models/connection_type_spec.rb
 - spec/models/strategy_order_record_status_spec.rb
-- spec/models/options_holdings_spec.rb
 - spec/models/redirect_tokenand_pin_spec.rb
 - spec/models/type_spec.rb
 - spec/models/model403_failed_request_response_spec.rb

data/lib/snaptrade/models/options_holdings.rb

@@ -1,267 +0,0 @@
-=begin
-#SnapTrade
-
-#Connect brokerage accounts to your app for live positions and trading
-
-The version of the OpenAPI document: 1.0.0
-Contact: api@snaptrade.com
-=end
-
-require 'date'
-require 'time'
-
-module SnapTrade
-  # Option Holdings
-  class OptionsHoldings
-    # Options information
-    attr_accessor :id
-
-    attr_accessor :symbol
-
-    attr_accessor :option_symbol
-
-    # Trade Price if limit or stop limit order
-    attr_accessor :price
-
-    attr_accessor :currency
-
-    # Average purchase price for this position
-    attr_accessor :average_purchase_price
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'id' => :'id',
-        :'symbol' => :'symbol',
-        :'option_symbol' => :'option_symbol',
-        :'price' => :'price',
-        :'currency' => :'currency',
-        :'average_purchase_price' => :'average_purchase_price'
-      }
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'id' => :'String',
-        :'symbol' => :'String',
-        :'option_symbol' => :'OptionsSymbol',
-        :'price' => :'Float',
-        :'currency' => :'Currency',
-        :'average_purchase_price' => :'Float'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'price',
-        :'average_purchase_price'
-      ])
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::OptionsHoldings` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::OptionsHoldings`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.key?(:'symbol')
-        self.symbol = attributes[:'symbol']
-      end
-
-      if attributes.key?(:'option_symbol')
-        self.option_symbol = attributes[:'option_symbol']
-      end
-
-      if attributes.key?(:'price')
-        self.price = attributes[:'price']
-      end
-
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
-      end
-
-      if attributes.key?(:'average_purchase_price')
-        self.average_purchase_price = attributes[:'average_purchase_price']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          id == o.id &&
-          symbol == o.symbol &&
-          option_symbol == o.option_symbol &&
-          price == o.price &&
-          currency == o.currency &&
-          average_purchase_price == o.average_purchase_price
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [id, symbol, option_symbol, price, currency, average_purchase_price].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = SnapTrade.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-  end
-
-end

data/spec/models/options_holdings_spec.rb

@@ -1,59 +0,0 @@
-=begin
-#SnapTrade
-
-#Connect brokerage accounts to your app for live positions and trading
-
-The version of the OpenAPI document: 1.0.0
-Contact: api@snaptrade.com
-=end
-
-require 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for SnapTrade::OptionsHoldings
-describe SnapTrade::OptionsHoldings do
-  let(:instance) { SnapTrade::OptionsHoldings.new }
-
-  describe 'test an instance of OptionsHoldings' do
-    it 'should create an instance of OptionsHoldings' do
-      expect(instance).to be_instance_of(SnapTrade::OptionsHoldings)
-    end
-  end
-  describe 'test attribute "id"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "symbol"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "option_symbol"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "price"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "currency"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "average_purchase_price"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-end