snaptrade 2.0.33 → 2.0.35

data/lib/snaptrade/api/connections_api.rb

@@ -527,8 +527,8 @@ module SnapTrade
     # Returns a list of session events associated with a user.
     #
     # @param partner_client_id [String] 
-    # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
-    # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
+    # @param user_id [String] Optional comma separated list of user IDs used to filter the request on specific users
+    # @param session_id [String] Optional comma separated list of session IDs used to filter the request on specific users
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def session_events(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
       extra[:user_id] = user_id if user_id != SENTINEL
@@ -542,8 +542,8 @@ module SnapTrade
     # Returns a list of session events associated with a user.
     #
     # @param partner_client_id [String] 
-    # @param user_id [String] Optional comma seperated list of user IDs used to filter the request on specific users
-    # @param session_id [String] Optional comma seperated list of session IDs used to filter the request on specific users
+    # @param user_id [String] Optional comma separated list of user IDs used to filter the request on specific users
+    # @param session_id [String] Optional comma separated list of session IDs used to filter the request on specific users
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def session_events_with_http_info(partner_client_id:, user_id: SENTINEL, session_id: SENTINEL, extra: {})
       extra[:user_id] = user_id if user_id != SENTINEL
@@ -555,8 +555,8 @@ module SnapTrade
     # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
-    # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
+    # @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
+    # @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
     # @return [Array<ConnectionsSessionEvents200ResponseInner>]
     private def session_events_impl(partner_client_id, opts = {})
       data, _status_code, _headers = session_events_with_http_info(partner_client_id, opts)
@@ -567,8 +567,8 @@ module SnapTrade
     # Returns a list of session events associated with a user.
     # @param partner_client_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
-    # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
+    # @option opts [String] :user_id Optional comma separated list of user IDs used to filter the request on specific users
+    # @option opts [String] :session_id Optional comma separated list of session IDs used to filter the request on specific users
     # @return [Array<(Array<ConnectionsSessionEvents200ResponseInner>, Integer, Hash)>] Array<ConnectionsSessionEvents200ResponseInner> data, response status code and response headers
     private def session_events_with_http_info_impl(partner_client_id, opts = {})
       if @api_client.config.debugging

data/lib/snaptrade/api/options_api.rb

@@ -372,36 +372,40 @@ module SnapTrade
     end
 
 
-    # Get account option holdings
+    # List account option positions
     #
-    # Returns a list of Options 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 account option holdings
+    # List account option positions
     #
-    # Returns a list of Options 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 account option holdings
-    # Returns a list of Options Positions. 
+    # 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>]
     private def list_option_holdings_impl(user_id, user_secret, account_id, opts = {})
@@ -409,11 +413,11 @@ module SnapTrade
       data
     end
 
-    # Get account option holdings
-    # Returns a list of Options Positions. 
+    # 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
     private def list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, opts = {})

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -19,15 +19,19 @@ module SnapTrade
 
     # Get transaction history for a user
     #
-    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+    # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+    # 
+    # There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+    # 
+    # The data returned here is always cached and refreshed once a day. **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 start_date [Date] 
-    # @param end_date [Date] 
-    # @param accounts [String] Optional comma seperated list of account IDs used to filter the request on specific accounts
-    # @param brokerage_authorizations [String] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-    # @param type [String] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+    # @param start_date [Date] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @param accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
+    # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
+    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_activities(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -41,15 +45,19 @@ module SnapTrade
 
     # Get transaction history for a user
     #
-    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+    # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+    # 
+    # There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+    # 
+    # The data returned here is always cached and refreshed once a day. **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 start_date [Date] 
-    # @param end_date [Date] 
-    # @param accounts [String] Optional comma seperated list of account IDs used to filter the request on specific accounts
-    # @param brokerage_authorizations [String] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-    # @param type [String] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+    # @param start_date [Date] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @param accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
+    # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
+    # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_activities_with_http_info(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -61,15 +69,15 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+    # Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. **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 [Hash] opts the optional parameters
-    # @option opts [Date] :start_date 
-    # @option opts [Date] :end_date 
-    # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
-    # @option opts [String] :brokerage_authorizations Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-    # @option opts [String] :type Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+    # @option opts [Date] :start_date The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
+    # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
+    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - BUY   - SELL   - DIVIDEND   - CONTRIBUTION   - WITHDRAWAL   - REI   - INTEREST   - FEE 
     # @return [Array<UniversalActivity>]
     private def get_activities_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = get_activities_with_http_info(user_id, user_secret, opts)
@@ -77,15 +85,15 @@ module SnapTrade
     end
 
     # Get transaction history for a user
-    # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+    # Returns all historical transactions for the specified user and filtering criteria. It&#39;s recommended to use &#x60;startDate&#x60; and &#x60;endDate&#x60; to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There&#39;s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the &#x60;trade_date&#x60; field if you need them in a specific order.  The data returned here is always cached and refreshed once a day. **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 [Hash] opts the optional parameters
-    # @option opts [Date] :start_date 
-    # @option opts [Date] :end_date 
-    # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
-    # @option opts [String] :brokerage_authorizations Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-    # @option opts [String] :type Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+    # @option opts [Date] :start_date The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
+    # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+    # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
+    # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
+    # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:   - BUY   - SELL   - DIVIDEND   - CONTRIBUTION   - WITHDRAWAL   - REI   - INTEREST   - FEE 
     # @return [Array<(Array<UniversalActivity>, Integer, Hash)>] Array<UniversalActivity> data, response status code and response headers
     private def get_activities_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging
@@ -155,7 +163,7 @@ module SnapTrade
     # @param end_date [Date] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param accounts [String] Optional comma seperated list of account IDs used to filter the request on specific accounts
+    # @param accounts [String] Optional comma separated list of account IDs used to filter the request on specific accounts
     # @param detailed [Boolean] Optional, increases frequency of data points for the total value and contribution charts if set to true
     # @param frequency [String] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -175,7 +183,7 @@ module SnapTrade
     # @param end_date [Date] 
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param accounts [String] Optional comma seperated list of account IDs used to filter the request on specific accounts
+    # @param accounts [String] Optional comma separated list of account IDs used to filter the request on specific accounts
     # @param detailed [Boolean] Optional, increases frequency of data points for the total value and contribution charts if set to true
     # @param frequency [String] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -193,7 +201,7 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
+    # @option opts [String] :accounts Optional comma separated list of account IDs used to filter the request on specific accounts
     # @option opts [Boolean] :detailed Optional, increases frequency of data points for the total value and contribution charts if set to true
     # @option opts [String] :frequency Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
     # @return [PerformanceCustom]
@@ -209,7 +217,7 @@ module SnapTrade
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
+    # @option opts [String] :accounts Optional comma separated list of account IDs used to filter the request on specific accounts
     # @option opts [Boolean] :detailed Optional, increases frequency of data points for the total value and contribution charts if set to true
     # @option opts [String] :frequency Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
     # @return [Array<(PerformanceCustom, Integer, Hash)>] PerformanceCustom data, response status code and response headers

data/lib/snaptrade/models/account.rb

@@ -11,22 +11,30 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # SnapTradeUser Investment Account
+  # A single brokerage account at a financial institution.
   class Account
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. If you want a stable identifier for the account, use the `number` field.
     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
 
+    # 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
 
+    # 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.
@@ -67,7 +75,7 @@ module SnapTrade
         :'name' => :'String',
         :'number' => :'String',
         :'institution_name' => :'String',
-        :'created_date' => :'String',
+        :'created_date' => :'Time',
         :'meta' => :'Hash<String, Object>',
         :'cash_restrictions' => :'Array<String>',
         :'sync_status' => :'AccountSyncStatus',
@@ -78,6 +86,7 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'name',
       ])
     end
 

data/lib/snaptrade/models/account_balance_total.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Total value of this account (includes cash, equity, fixed income, etc)
+  # Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account.
   class AccountBalanceTotal
     # Total value denominated in the currency of the `currency` field.
     attr_accessor :amount
@@ -46,13 +46,6 @@ module SnapTrade
       ])
     end
 
-    # List of class defined in allOf (OpenAPI v3)
-    def self.openapi_all_of
-      [
-      :'Amount'
-      ]
-    end
-
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})

data/lib/snaptrade/models/account_holdings_account.rb

@@ -49,7 +49,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'account' => :'SnapTradeHoldingsAccountAccountId',
+        :'account' => :'Account',
         :'balances' => :'Array<Balance>',
         :'positions' => :'Array<Position>',
         :'option_positions' => :'Array<OptionsPosition>',

data/lib/snaptrade/models/account_order_record.rb

@@ -53,7 +53,7 @@ module SnapTrade
     # The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
     attr_accessor :order_type
 
-    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `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.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date. 
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `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.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day's opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. 
     attr_accessor :time_in_force
 
     # The time the order was placed. This is the time the order was submitted to the brokerage.

data/lib/snaptrade/models/account_order_record_universal_symbol.rb

@@ -67,8 +67,8 @@ module SnapTrade
         :'symbol' => :'String',
         :'raw_symbol' => :'String',
         :'description' => :'String',
-        :'currency' => :'UniversalSymbolCurrency',
-        :'exchange' => :'UniversalSymbolExchange',
+        :'currency' => :'SymbolCurrency',
+        :'exchange' => :'SymbolExchange',
         :'type' => :'SecurityType',
         :'currencies' => :'Array<Currency>',
         :'figi_code' => :'String',

data/lib/snaptrade/models/account_simple.rb

@@ -11,12 +11,15 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # SnapTradeUser Investment Account
+  # A single brokerage account at a financial institution.
   class AccountSimple
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :id
 
+    # 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
 
     attr_accessor :sync_status

data/lib/snaptrade/models/account_sync_status.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Status of account
+  # Contains status update for the account sync process between SnapTrade and the brokerage.
   class AccountSyncStatus
     attr_accessor :transactions
 

data/lib/snaptrade/models/balance.rb

@@ -38,7 +38,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'currency' => :'Currency',
+        :'currency' => :'BalanceCurrency',
         :'cash' => :'Float',
         :'buying_power' => :'Float'
       }

data/lib/snaptrade/models/{snap_trade_holdings_account_account_id_balance.rb → balance_currency.rb}

@@ -11,13 +11,23 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class SnapTradeHoldingsAccountAccountIdBalance
-    attr_accessor :total
+  # The currency of the balance. This applies to both `cash` and `buying_power`.
+  class BalanceCurrency
+    # 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.
     def self.attribute_map
       {
-        :'total' => :'total'
+        :'id' => :'id',
+        :'code' => :'code',
+        :'name' => :'name'
       }
     end
 
@@ -29,21 +39,22 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'total' => :'AccountBalanceTotal'
+        :'id' => :'String',
+        :'code' => :'String',
+        :'name' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'total'
       ])
     end
 
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'AccountBalance'
+      :'Currency'
       ]
     end
 
@@ -51,19 +62,27 @@ module SnapTrade
     # @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::SnapTradeHoldingsAccountAccountIdBalance` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::BalanceCurrency` 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::SnapTradeHoldingsAccountAccountIdBalance`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::BalanceCurrency`. 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?(:'total')
-        self.total = attributes[:'total']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
     end
 
@@ -85,7 +104,9 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          total == o.total
+          id == o.id &&
+          code == o.code &&
+          name == o.name
     end
 
     # @see the `==` method
@@ -97,7 +118,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [total].hash
+      [id, code, name].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/delete_user_response.rb

@@ -11,11 +11,13 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Response when delete user is successful
   class DeleteUserResponse
-    # Delete status
+    # This is always `deleted` when a user is queued for deletion.
     attr_accessor :status
 
+    # Human friendly message about the deletion status.
+    attr_accessor :detail
+
     # 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.
     attr_accessor :user_id
 
@@ -23,6 +25,7 @@ module SnapTrade
     def self.attribute_map
       {
         :'status' => :'status',
+        :'detail' => :'detail',
         :'user_id' => :'userId'
       }
     end
@@ -36,6 +39,7 @@ module SnapTrade
     def self.openapi_types
       {
         :'status' => :'String',
+        :'detail' => :'String',
         :'user_id' => :'String'
       }
     end
@@ -65,6 +69,10 @@ module SnapTrade
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
       if attributes.key?(:'user_id')
         self.user_id = attributes[:'user_id']
       end
@@ -89,6 +97,7 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           status == o.status &&
+          detail == o.detail &&
           user_id == o.user_id
     end
 
@@ -101,7 +110,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, user_id].hash
+      [status, detail, user_id].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/holdings_status.rb

@@ -11,11 +11,12 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Status of account holdings sync
+  # Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 
   class HoldingsStatus
+    # Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete.
     attr_accessor :initial_sync_completed
 
-    # Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
+    # The last time holdings were successfully synced by SnapTrade.
     attr_accessor :last_successful_sync
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -35,14 +36,13 @@ module SnapTrade
     def self.openapi_types
       {
         :'initial_sync_completed' => :'Boolean',
-        :'last_successful_sync' => :'String'
+        :'last_successful_sync' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'last_successful_sync'
       ])
     end
 

data/lib/snaptrade/models/login_redirect_uri.rb

@@ -13,8 +13,10 @@ require 'time'
 module SnapTrade
   # Redirect uri upon successful login
   class LoginRedirectURI
+    # Connection Portal link to redirect user to connect a brokerage account.
     attr_accessor :redirect_uri
 
+    # ID to identify the connection portal session.
     attr_accessor :session_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -33,7 +35,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'redirect_uri' => :'Object',
+        :'redirect_uri' => :'String',
         :'session_id' => :'String'
       }
     end
@@ -41,7 +43,6 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'redirect_uri',
       ])
     end