snaptrade 2.0.36 → 2.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e8a3e30ce711edef7835ce59691c2709524f4d40add0b1913146ac04a56efaf
-  data.tar.gz: 1ceed48b23a0c73555e2f13804dbeb51b819d2c39dca6edef6314674aae99ca2
+  metadata.gz: b9395a7a9c5148bdb86a0b86e948181fef7189924188c4da86cf27a89ed75c57
+  data.tar.gz: 5c1cca0121a0d496d6fb3be53b67a6e500104568b32276a13763f770d2f151f6
 SHA512:
-  metadata.gz: 35df36a5be0fd0f2885229ee237b7938073703d7eb9878a4b77092a9dc6964afbeed9da5454434e02a3e45af466bff57ad9f8e25fe11c254cb6c2cc9ac17c8f7
-  data.tar.gz: c3e1f881f4509c8a8617e32c7cd25d583cba44c0e11b4633464867af8fed1ac592183645d6faf6594c671d6c1d5618afee35deb8ab92ba8e728b4a3c4af43f8b
+  metadata.gz: 7c3294b628c979b2c77328aa2b6a04784ffd2b3135c4bc7744bf21321e86c13aabeeb358631d9d71df1a9f690f0773f70d28174e5b194e691490b410dee455de
+  data.tar.gz: fb57f0a91a559a936fec3a109a0784d893ef9ac0d72a519efd527c4c1f5baf9f188d72692cd62808f823c90e88a12694b51c8505a994dade123f874e4550e66e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.36)
+    snaptrade (2.0.38)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -52,7 +52,7 @@ GEM
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)

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.36-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.36)
+[![npm](https://img.shields.io/badge/gem-v2.0.38-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.38)
 [![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.36'
+gem 'snaptrade', '~> 2.0.38'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -84,7 +84,7 @@ configuration.consumer_key = ENV["SNAPTRADE_CONSUMER_KEY"]
 snaptrade = SnapTrade::Client.new(configuration)
 result = snaptrade.account_information.get_all_user_holdings(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -97,7 +97,7 @@ To access the raw HTTP response, suffix any method with `_with_http_info`.
 ```ruby
 result = snaptrade.account_information.get_all_user_holdings_with_http_info(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result[0] # [Array<AccountHoldings>] Deserialized data
@@ -123,7 +123,7 @@ account.
 ```ruby
 result = snaptrade.account_information.get_all_user_holdings(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -162,7 +162,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.account_information.get_user_account_balance(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -198,7 +198,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 ```ruby
 result = snaptrade.account_information.get_user_account_details(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -234,7 +234,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.account_information.get_user_account_orders(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   state: "all",
   days: 30,
@@ -279,7 +279,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.account_information.get_user_account_positions(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -316,7 +316,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 result = snaptrade.account_information.get_user_holdings(
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -341,7 +341,7 @@ p result
 
 ### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
 
-Returns all brokerage accounts known to SnapTrade for the authenticated user.
+Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
 
 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**.
 
@@ -351,7 +351,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 ```ruby
 result = snaptrade.account_information.list_user_accounts(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -382,7 +382,7 @@ Updates various properties of a specified account.
 ```ruby
 result = snaptrade.account_information.update_user_account(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
 )
 p result
@@ -463,7 +463,7 @@ p result
 
 ### `snaptrade.authentication.list_snap_trade_users`<a id="snaptradeauthenticationlist_snap_trade_users"></a>
 
-Returns a list of all registered user IDs.
+Returns a list of all registered user IDs. Please note that the response is not currently paginated.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -490,7 +490,7 @@ Logs in a SnapTrade user and returns an authenticated connection portal URL for
 ```ruby
 result = snaptrade.authentication.login_snap_trade_user(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   broker: "ALPACA",
   immediate_redirect: true,
   custom_redirect: "https://snaptrade.com",
@@ -552,8 +552,8 @@ Sets the version of the connection portal to render.
 
 ### `snaptrade.authentication.register_snap_trade_user`<a id="snaptradeauthenticationregister_snap_trade_user"></a>
 
-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.
+Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -596,7 +596,7 @@ Rotates the secret for a SnapTrade user. You might use this if `userSecret` is c
 ```ruby
 result = snaptrade.authentication.reset_snap_trade_user_secret(
   user_id: "snaptrade-user-123",
-  user_secret: "h81@cx1lkalablakwjaltkejraj11=",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -610,9 +610,9 @@ NOT use email addresses for this property because they are usually not
 immutable.
 
 ##### userSecret: `String`<a id="usersecret-string"></a>
-SnapTrade User Secret randomly generated by SnapTrade. This is privileged
-information and if compromised, should be rotated via the [rotate user secret
-endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+SnapTrade User Secret. This is a randomly generated string and should be stored
+securely. If compromised, please rotate it via the [rotate user secret
+endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -629,15 +629,15 @@ endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
 
 ### `snaptrade.connections.detail_brokerage_authorization`<a id="snaptradeconnectionsdetail_brokerage_authorization"></a>
 
-Returns a single brokerage authorization object for the specified ID.
+Returns a single connection for the specified ID.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
 result = snaptrade.connections.detail_brokerage_authorization(
-  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -645,8 +645,6 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### authorization_id: `String`<a id="authorization_id-string"></a>
-The ID of a brokerage authorization object.
-
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -664,15 +662,19 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.disable_brokerage_authorization`<a id="snaptradeconnectionsdisable_brokerage_authorization"></a>
 
-Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.
+Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections.
+Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_broken) for the connection.
+
+*Please contact us in order to use this endpoint as it is disabled by default.*
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
 result = snaptrade.connections.disable_brokerage_authorization(
-  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -680,8 +682,6 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### authorization_id: `String`<a id="authorization_id-string"></a>
-The ID of a brokerage authorization object.
-
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -699,14 +699,19 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.list_brokerage_authorizations`<a id="snaptradeconnectionslist_brokerage_authorizations"></a>
 
-Returns a list of Brokerage Authorization objects for the user
+Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.
+
+A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
+
+SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
 result = snaptrade.connections.list_brokerage_authorizations(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -730,15 +735,18 @@ 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. Please contact support for access as this endpoint is not enabled by default
+Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
+
+*Please contact support for access as this endpoint is not enabled by default.*
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
 result = snaptrade.connections.refresh_brokerage_authorization(
-  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 p result
 ```
@@ -746,8 +754,6 @@ p result
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### authorization_id: `String`<a id="authorization_id-string"></a>
-The ID of a brokerage authorization object.
-
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 #### 🔄 Return<a id="🔄-return"></a>
@@ -765,23 +771,21 @@ The ID of a brokerage authorization object.
 
 ### `snaptrade.connections.remove_brokerage_authorization`<a id="snaptradeconnectionsremove_brokerage_authorization"></a>
 
-Deletes a specified brokerage authorization given by the ID.
+Deletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
 snaptrade.connections.remove_brokerage_authorization(
-  authorization_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
+  authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
 ```
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
 ##### authorization_id: `String`<a id="authorization_id-string"></a>
-The ID of the Authorization to delete.
-
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
@@ -851,7 +855,7 @@ result = snaptrade.options.get_option_strategy(
     ],
   strategy_type: "CUSTOM",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
 )
 p result
@@ -889,7 +893,7 @@ Returns the option chain for the specified symbol in the specified account.
 ```ruby
 result = snaptrade.options.get_options_chain(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
   symbol: "symbol_example",
 )
@@ -929,7 +933,7 @@ Returns a Strategy Quotes object which has latest market data of the specified o
 ```ruby
 result = snaptrade.options.get_options_strategy_quote(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "accountId_example",
   option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
 )
@@ -971,7 +975,7 @@ The data returned here is cached. How long the data is cached for varies by brok
 ```ruby
 result = snaptrade.options.list_option_holdings(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
@@ -1006,7 +1010,7 @@ result = snaptrade.options.place_option_strategy(
   order_type: "Limit",
   time_in_force: "FOK",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   option_strategy_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   price: 31.33,
@@ -1328,7 +1332,7 @@ provided search string, matching on ticker and name.
 ```ruby
 result = snaptrade.reference_data.symbol_search_user_account(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   substring: "apple",
 )
@@ -1367,7 +1371,7 @@ This will only work if the order has not yet been executed.
 ```ruby
 result = snaptrade.trading.cancel_user_account_order(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   brokerage_order_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
 )
@@ -1404,7 +1408,7 @@ Return the trade object and it's impact on the account for the specified order.
 ```ruby
 result = snaptrade.trading.get_order_impact(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
   order_type: "Limit",
@@ -1464,7 +1468,7 @@ Returns quote(s) from the brokerage for the specified symbol(s).
 ```ruby
 result = snaptrade.trading.get_user_account_quotes(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   symbols: "symbols_example",
   account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
   use_ticker: true,
@@ -1507,7 +1511,7 @@ Places a specified trade in the specified account.
 ```ruby
 result = snaptrade.trading.place_force_order(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
   action: "BUY",
   order_type: "Limit",
@@ -1570,7 +1574,7 @@ returns the status of the order from the brokerage.
 result = snaptrade.trading.place_order(
   trade_id: "tradeId_example",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   wait_to_confirm: true,
 )
 p result
@@ -1616,7 +1620,7 @@ The data returned here is always cached and refreshed once a day. **If you need
 ```ruby
 result = snaptrade.transactions_and_reporting.get_activities(
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   start_date: "2022-01-24",
   end_date: "2022-01-24",
   accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
@@ -1683,7 +1687,7 @@ result = snaptrade.transactions_and_reporting.get_reporting_custom_range(
   start_date: "2022-01-24",
   end_date: "2022-01-24",
   user_id: "snaptrade-user-123",
-  user_secret: "USERSECRET123",
+  user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
   accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
   detailed: true,
   frequency: "monthly",

data/lib/snaptrade/api/account_information_api.rb

@@ -684,7 +684,7 @@ module SnapTrade
 
     # List accounts
     #
-    # Returns all brokerage accounts known to SnapTrade for the authenticated user.
+    # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
     # 
     # 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**.
     #
@@ -698,7 +698,7 @@ module SnapTrade
 
     # List accounts
     #
-    # Returns all brokerage accounts known to SnapTrade for the authenticated user.
+    # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
     # 
     # 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**.
     #
@@ -710,7 +710,7 @@ module SnapTrade
     end
 
     # List accounts
-    # Returns all brokerage accounts known to SnapTrade for the authenticated user.  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**. 
+    # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  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
@@ -721,7 +721,7 @@ module SnapTrade
     end
 
     # List accounts
-    # Returns all brokerage accounts known to SnapTrade for the authenticated user.  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**. 
+    # Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.  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

data/lib/snaptrade/api/authentication_api.rb

@@ -105,7 +105,7 @@ module SnapTrade
 
     # List all users
     #
-    # Returns a list of all registered user IDs.
+    # Returns a list of all registered user IDs. Please note that the response is not currently paginated.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users(extra: {})
@@ -115,7 +115,7 @@ module SnapTrade
 
     # List all users
     #
-    # Returns a list of all registered user IDs.
+    # Returns a list of all registered user IDs. Please note that the response is not currently paginated.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users_with_http_info(extra: {})
@@ -123,7 +123,7 @@ module SnapTrade
     end
 
     # List all users
-    # Returns a list of all registered user IDs.
+    # Returns a list of all registered user IDs. Please note that the response is not currently paginated.
     # @param [Hash] opts the optional parameters
     # @return [Array<String>]
     private def list_snap_trade_users_impl(opts = {})
@@ -132,7 +132,7 @@ module SnapTrade
     end
 
     # List all users
-    # Returns a list of all registered user IDs.
+    # Returns a list of all registered user IDs. Please note that the response is not currently paginated.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     private def list_snap_trade_users_with_http_info_impl(opts = {})
@@ -314,8 +314,8 @@ module SnapTrade
 
     # Register user
     #
-    # 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.
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+    # Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
     #
     # @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
 
     # Register user
     #
-    # 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.
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system.
+    # Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
     #
     # @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
 
     # Register user
-    # 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. 
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -354,7 +354,7 @@ module SnapTrade
     end
 
     # Register user
-    # 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. 
+    # Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters. 
     # @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
@@ -417,7 +417,7 @@ module SnapTrade
     # Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
     #
     # @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 user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+    # @param user_secret [String] SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def reset_snap_trade_user_secret(user_id: SENTINEL, user_secret: SENTINEL, extra: {})
@@ -434,7 +434,7 @@ module SnapTrade
     # Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
     #
     # @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 user_secret [String] SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
+    # @param user_secret [String] SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
     # @param body [UserIDandSecret] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def reset_snap_trade_user_secret_with_http_info(user_id: SENTINEL, user_secret: SENTINEL, extra: {})