snaptrade 1.17.10 → 2.0.77

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'cgi'
@@ -19,14 +18,20 @@ 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.
+    #
     # @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` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another 
     # @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
@@ -39,14 +44,20 @@ 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.
+    #
     # @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` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another 
     # @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
@@ -58,33 +69,33 @@ 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. 
     # @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` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another 
     # @return [Array<UniversalActivity>]
-    def get_activities_impl(user_id, user_secret, opts = {})
+    private def get_activities_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = get_activities_with_http_info(user_id, user_secret, opts)
       data
     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. 
     # @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` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another 
     # @return [Array<(Array<UniversalActivity>, Integer, Hash)>] Array<UniversalActivity> data, response status code and response headers
-    def get_activities_with_http_info_impl(user_id, user_secret, opts = {})
+    private def get_activities_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransactionsAndReportingApi.get_activities ...'
       end
@@ -145,12 +156,14 @@ module SnapTrade
 
 
     # Get performance information for a specific timeframe
+    #
     # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
+    #
     # @param start_date [Date] 
     # @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
@@ -163,12 +176,14 @@ module SnapTrade
     end
 
     # Get performance information for a specific timeframe
+    #
     # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
+    #
     # @param start_date [Date] 
     # @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
@@ -186,11 +201,11 @@ 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]
-    def get_reporting_custom_range_impl(start_date, end_date, user_id, user_secret, opts = {})
+    private def get_reporting_custom_range_impl(start_date, end_date, user_id, user_secret, opts = {})
       data, _status_code, _headers = get_reporting_custom_range_with_http_info(start_date, end_date, user_id, user_secret, opts)
       data
     end
@@ -202,11 +217,11 @@ 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
-    def get_reporting_custom_range_with_http_info_impl(start_date, end_date, user_id, user_secret, opts = {})
+    private def get_reporting_custom_range_with_http_info_impl(start_date, end_date, user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransactionsAndReportingApi.get_reporting_custom_range ...'
       end

data/lib/snaptrade/api_client.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -179,7 +178,6 @@ module SnapTrade
 
     def build_connection
       Faraday.new(url: config.base_url, ssl: ssl_options) do |conn|
-        basic_auth(conn)
         config.configure_middleware(conn)
         yield(conn) if block_given?
         conn.adapter(Faraday.default_adapter)
@@ -196,16 +194,6 @@ module SnapTrade
       }
     end
 
-    def basic_auth(conn)
-      if config.username && config.password
-        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
-          conn.request(:authorization, :basic, config.username, config.password)
-        else
-          conn.request(:basic_auth, config.username, config.password)
-        end
-      end
-    end
-
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -342,9 +330,11 @@ module SnapTrade
       Array(auth_names).each do |auth_name|
         auth_setting = @config.auth_settings[auth_name]
         next unless auth_setting
+        value = auth_setting[:value]
+        next unless value
         case auth_setting[:in]
-        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
-        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        when 'header' then header_params[auth_setting[:key]] = value
+        when 'query'  then query_params[auth_setting[:key]] = value
         else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
@@ -424,4 +414,24 @@ module SnapTrade
       end
     end
   end
+
+  # Represents an HTTP response for method that end with *_with_http_info
+  class APIResponse
+    # [Object] deserialized data
+    attr_reader :data
+    # [Integer] response status code
+    attr_reader :status_code
+    # [Hash] response headers
+    attr_reader :headers
+    # [Faraday::Response] the original Faraday response object
+    attr_reader :response
+
+    def initialize(data, status_code, headers, response)
+      @data = data
+      @status_code = status_code
+      @headers = headers
+      @response = response
+    end
+
+  end
 end

data/lib/snaptrade/api_error.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 module SnapTrade

data/lib/snaptrade/configuration.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 module SnapTrade
@@ -32,15 +31,15 @@ module SnapTrade
     attr_accessor :server_operation_variables
 
     def client_id=(value)
-      @api_key['PartnerClientId'] = value
+      @api_key_store['PartnerClientId'] = value
     end
 
     def signature=(value)
-      @api_key['PartnerSignature'] = value
+      @api_key_store['PartnerSignature'] = value
     end
 
     def timestamp=(value)
-      @api_key['PartnerTimestamp'] = value
+      @api_key_store['PartnerTimestamp'] = value
     end
 
     # client state configured through konfig.yaml
@@ -58,8 +57,8 @@ module SnapTrade
     # @return [Hash] key: parameter name, value: parameter value (API key)
     #
     # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
+    #   config.api_key_store['api_key'] = 'xxx'
+    attr_accessor :api_key_store
 
     # Defines API key prefixes used with API Key authentications.
     #
@@ -69,19 +68,6 @@ module SnapTrade
     #   config.api_key_prefix['api_key'] = 'Token'
     attr_accessor :api_key_prefix
 
-    # Defines the username used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :username
-
-    # Defines the password used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :password
-
-    # Defines the access token (Bearer) used with OAuth2.
-    attr_accessor :access_token
-
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -165,7 +151,7 @@ module SnapTrade
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
-      @api_key = {}
+      @api_key_store = {}
       @api_key_prefix = {}
       @client_side_validation = true
       @ssl_verify = true
@@ -233,20 +219,16 @@ module SnapTrade
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
     def api_key_with_prefix(param_name, param_alias = nil)
-      key = @api_key[param_name]
-      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
+      value = @api_key_store[param_name]
+      value = @api_key_store.fetch(param_alias, value) unless param_alias.nil?
+      return nil if value.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{key}"
+        "#{@api_key_prefix[param_name]}#{value}"
       else
-        key
+        value
       end
     end
 
-    # Gets Basic Auth token string
-    def basic_auth_token
-      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
-    end
-
     # Returns Auth Settings hash for api client.
     def auth_settings
       {

data/lib/snaptrade/models/account.rb

@@ -5,51 +5,63 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
 require 'time'
 
 module SnapTrade
-  # SnapTradeUser Investment Account
+  # A single account at a brokerage.
   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.
     attr_accessor :id
 
+    # Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
     attr_accessor :brokerage_authorization
 
-    attr_accessor :portfolio_group
-
+    # A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
     attr_accessor :name
 
+    # The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
     attr_accessor :number
 
+    # The name of the brokerage 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 brokerage.
     attr_accessor :created_date
 
+    attr_accessor :sync_status
+
+    attr_accessor :balance
+
+    # Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.
     attr_accessor :meta
 
-    attr_accessor :cash_restrictions
+    # Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
+    attr_accessor :portfolio_group
 
-    attr_accessor :sync_status
+    # This field is deprecated.
+    attr_accessor :cash_restrictions
 
-    attr_accessor :balance
+    # The account type as provided by the brokerage
+    attr_accessor :raw_type
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'brokerage_authorization' => :'brokerage_authorization',
-        :'portfolio_group' => :'portfolio_group',
         :'name' => :'name',
         :'number' => :'number',
         :'institution_name' => :'institution_name',
         :'created_date' => :'created_date',
+        :'sync_status' => :'sync_status',
+        :'balance' => :'balance',
         :'meta' => :'meta',
+        :'portfolio_group' => :'portfolio_group',
         :'cash_restrictions' => :'cash_restrictions',
-        :'sync_status' => :'sync_status',
-        :'balance' => :'balance'
+        :'raw_type' => :'raw_type'
       }
     end
 
@@ -63,21 +75,24 @@ module SnapTrade
       {
         :'id' => :'String',
         :'brokerage_authorization' => :'String',
-        :'portfolio_group' => :'String',
         :'name' => :'String',
         :'number' => :'String',
         :'institution_name' => :'String',
-        :'created_date' => :'String',
-        :'meta' => :'Hash<String, Object>',
-        :'cash_restrictions' => :'Array<CashRestriction>',
+        :'created_date' => :'Time',
         :'sync_status' => :'AccountSyncStatus',
-        :'balance' => :'AccountBalance'
+        :'balance' => :'AccountBalance',
+        :'meta' => :'Hash<String, Object>',
+        :'portfolio_group' => :'String',
+        :'cash_restrictions' => :'Array<String>',
+        :'raw_type' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'name',
+        :'raw_type'
       ])
     end
 
@@ -104,10 +119,6 @@ module SnapTrade
         self.brokerage_authorization = attributes[:'brokerage_authorization']
       end
 
-      if attributes.key?(:'portfolio_group')
-        self.portfolio_group = attributes[:'portfolio_group']
-      end
-
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -124,24 +135,32 @@ module SnapTrade
         self.created_date = attributes[:'created_date']
       end
 
+      if attributes.key?(:'sync_status')
+        self.sync_status = attributes[:'sync_status']
+      end
+
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
+      end
+
       if attributes.key?(:'meta')
         if (value = attributes[:'meta']).is_a?(Hash)
           self.meta = value
         end
       end
 
+      if attributes.key?(:'portfolio_group')
+        self.portfolio_group = attributes[:'portfolio_group']
+      end
+
       if attributes.key?(:'cash_restrictions')
         if (value = attributes[:'cash_restrictions']).is_a?(Array)
           self.cash_restrictions = value
         end
       end
 
-      if attributes.key?(:'sync_status')
-        self.sync_status = attributes[:'sync_status']
-      end
-
-      if attributes.key?(:'balance')
-        self.balance = attributes[:'balance']
+      if attributes.key?(:'raw_type')
+        self.raw_type = attributes[:'raw_type']
       end
     end
 
@@ -149,12 +168,47 @@ module SnapTrade
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @brokerage_authorization.nil?
+        invalid_properties.push('invalid value for "brokerage_authorization", brokerage_authorization cannot be nil.')
+      end
+
+      if @number.nil?
+        invalid_properties.push('invalid value for "number", number cannot be nil.')
+      end
+
+      if @institution_name.nil?
+        invalid_properties.push('invalid value for "institution_name", institution_name cannot be nil.')
+      end
+
+      if @created_date.nil?
+        invalid_properties.push('invalid value for "created_date", created_date cannot be nil.')
+      end
+
+      if @sync_status.nil?
+        invalid_properties.push('invalid value for "sync_status", sync_status cannot be nil.')
+      end
+
+      if @balance.nil?
+        invalid_properties.push('invalid value for "balance", balance cannot be nil.')
+      end
+
       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?
+      return false if @id.nil?
+      return false if @brokerage_authorization.nil?
+      return false if @number.nil?
+      return false if @institution_name.nil?
+      return false if @created_date.nil?
+      return false if @sync_status.nil?
+      return false if @balance.nil?
       true
     end
 
@@ -165,15 +219,16 @@ module SnapTrade
       self.class == o.class &&
           id == o.id &&
           brokerage_authorization == o.brokerage_authorization &&
-          portfolio_group == o.portfolio_group &&
           name == o.name &&
           number == o.number &&
           institution_name == o.institution_name &&
           created_date == o.created_date &&
+          sync_status == o.sync_status &&
+          balance == o.balance &&
           meta == o.meta &&
+          portfolio_group == o.portfolio_group &&
           cash_restrictions == o.cash_restrictions &&
-          sync_status == o.sync_status &&
-          balance == o.balance
+          raw_type == o.raw_type
     end
 
     # @see the `==` method
@@ -185,7 +240,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, brokerage_authorization, portfolio_group, name, number, institution_name, created_date, meta, cash_restrictions, sync_status, balance].hash
+      [id, brokerage_authorization, name, number, institution_name, created_date, sync_status, balance, meta, portfolio_group, cash_restrictions, raw_type].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/account_balance.rb

@@ -5,14 +5,13 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 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

@@ -5,17 +5,18 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 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
 
+    # The ISO-4217 currency code for the amount.
     attr_accessor :currency
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -45,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.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'