lib/snaptrade/api/account_information_api.rb in snaptrade-2.0.29 vs lib/snaptrade/api/account_information_api.rb in snaptrade-2.0.30
- old
+ new
@@ -17,12 +17,14 @@
@api_client = api_client
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 brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -32,12 +34,14 @@
data
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 brokerage_authorizations [String] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -45,11 +49,11 @@
extra[:brokerage_authorizations] = brokerage_authorizations if brokerage_authorizations != SENTINEL
get_all_user_holdings_with_http_info_impl(user_id, user_secret, extra)
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
# @option opts [String] :brokerage_authorizations Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
# @return [Array<AccountHoldings>]
@@ -57,10 +61,10 @@
data, _status_code, _headers = get_all_user_holdings_with_http_info(user_id, user_secret, opts)
data
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
# @option opts [String] :brokerage_authorizations Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
# @return [Array<(Array<AccountHoldings>, Integer, Hash)>] Array<AccountHoldings> data, response status code and response headers