snaptrade 2.0.37 → 2.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88f22af63ef634b29b544f5bbc26cf9b13e9308b6f4ef33dfb560661fd5634f8
-  data.tar.gz: 86ff19da7e1921510e08601478baf357a1185d3c2637dcc1652844ec538d5a95
+  metadata.gz: b9395a7a9c5148bdb86a0b86e948181fef7189924188c4da86cf27a89ed75c57
+  data.tar.gz: 5c1cca0121a0d496d6fb3be53b67a6e500104568b32276a13763f770d2f151f6
 SHA512:
-  metadata.gz: 58e865b388be36ed872dffde28d4e52ecf65b9ac0432438c3ac3882856d6cda10414360a7a1f86b58a8473097ce978525f254a4461fb8f89e15d820def612fd6
-  data.tar.gz: 40803cf194c7788f5e695f4cb72bb9db2af3afa69a6f98bcec8268ff2af8ce1c008d4414f142f63452658b83b53f6954a831a715572849b69f2697e287ff28a8
+  metadata.gz: 7c3294b628c979b2c77328aa2b6a04784ffd2b3135c4bc7744bf21321e86c13aabeeb358631d9d71df1a9f690f0773f70d28174e5b194e691490b410dee455de
+  data.tar.gz: fb57f0a91a559a936fec3a109a0784d893ef9ac0d72a519efd527c4c1f5baf9f188d72692cd62808f823c90e88a12694b51c8505a994dade123f874e4550e66e

data/Gemfile.lock

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

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.37-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.37)
+[![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.37'
+gem 'snaptrade', '~> 2.0.38'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -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**.
 
@@ -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>
 
@@ -629,13 +629,13 @@ 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: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
@@ -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,13 +662,17 @@ 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: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
@@ -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,7 +699,12 @@ 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>
 
@@ -730,13 +735,16 @@ 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: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
@@ -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,13 +771,13 @@ 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: "adf2aa34-8219-40f7-a6b3-60156985cc61",
 )
@@ -780,8 +786,6 @@ snaptrade.connections.remove_brokerage_authorization(
 #### ⚙️ 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>

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 = {})

data/lib/snaptrade/api/connections_api.rb

@@ -17,11 +17,11 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Get brokerage authorization details
+    # Get connection detail
     #
-    # Returns a single brokerage authorization object for the specified ID.
+    # Returns a single connection for the specified ID.
     #
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -30,11 +30,11 @@ module SnapTrade
       data
     end
 
-    # Get brokerage authorization details
+    # Get connection detail
     #
-    # Returns a single brokerage authorization object for the specified ID.
+    # Returns a single connection for the specified ID.
     #
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -42,9 +42,9 @@ module SnapTrade
       detail_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
     end
 
-    # Get brokerage authorization details
-    # Returns a single brokerage authorization object for the specified ID.
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Get connection detail
+    # Returns a single connection for the specified ID.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -54,9 +54,9 @@ module SnapTrade
       data
     end
 
-    # Get brokerage authorization details
-    # Returns a single brokerage authorization object for the specified ID.
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Get connection detail
+    # Returns a single connection for the specified ID.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -120,11 +120,14 @@ module SnapTrade
     end
 
 
-    # Manually disable a connection for testing
+    # Force disable connection
     #
-    # 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.*
     #
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -133,11 +136,14 @@ module SnapTrade
       data
     end
 
-    # Manually disable a connection for testing
+    # Force disable connection
     #
-    # 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.*
     #
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -145,9 +151,9 @@ module SnapTrade
       disable_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
     end
 
-    # Manually disable a connection for testing
-    # 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.
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Force disable connection
+    # 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.* 
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -157,9 +163,9 @@ module SnapTrade
       data
     end
 
-    # Manually disable a connection for testing
-    # 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.
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # Force disable connection
+    # 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.* 
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -223,9 +229,13 @@ module SnapTrade
     end
 
 
-    # List all brokerage authorizations for the User
+    # List all connections
     #
-    # 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.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -235,9 +245,13 @@ module SnapTrade
       data
     end
 
-    # List all brokerage authorizations for the User
+    # List all connections
     #
-    # 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.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -246,8 +260,8 @@ module SnapTrade
       list_brokerage_authorizations_with_http_info_impl(user_id, user_secret, extra)
     end
 
-    # List all brokerage authorizations for the User
-    # Returns a list of Brokerage Authorization objects for the user
+    # List all connections
+    # 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. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -257,8 +271,8 @@ module SnapTrade
       data
     end
 
-    # List all brokerage authorizations for the User
-    # Returns a list of Brokerage Authorization objects for the user
+    # List all connections
+    # 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. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -320,9 +334,11 @@ module SnapTrade
 
     # Refresh holdings for a connection
     #
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. 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.*
     #
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -333,9 +349,11 @@ module SnapTrade
 
     # Refresh holdings for a connection
     #
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. 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.*
     #
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -344,8 +362,8 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # 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.* 
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -356,8 +374,8 @@ module SnapTrade
     end
 
     # Refresh holdings for a connection
-    # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
-    # @param authorization_id [String] The ID of a brokerage authorization object.
+    # 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.* 
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -421,11 +439,11 @@ module SnapTrade
     end
 
 
-    # Delete brokerage authorization
+    # Delete connection
     #
-    # 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.
     #
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -434,11 +452,11 @@ module SnapTrade
       nil
     end
 
-    # Delete brokerage authorization
+    # Delete connection
     #
-    # 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.
     #
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -446,9 +464,9 @@ module SnapTrade
       remove_brokerage_authorization_with_http_info_impl(authorization_id, user_id, user_secret, extra)
     end
 
-    # Delete brokerage authorization
-    # Deletes a specified brokerage authorization given by the ID.
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # Delete connection
+    # 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.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters
@@ -458,9 +476,9 @@ module SnapTrade
       nil
     end
 
-    # Delete brokerage authorization
-    # Deletes a specified brokerage authorization given by the ID.
-    # @param authorization_id [String] The ID of the Authorization to delete.
+    # Delete connection
+    # 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.
+    # @param authorization_id [String] 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param [Hash] opts the optional parameters

data/lib/snaptrade/models/account.rb

@@ -16,7 +16,7 @@ module SnapTrade
     # 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 (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
+    # Unique identifier for the connection. 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.
@@ -34,7 +34,7 @@ module SnapTrade
     # 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
 
-    # 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. Please use at your own risk.
+    # 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
 
     # This field is deprecated.

data/lib/snaptrade/models/brokerage.rb

@@ -11,62 +11,69 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # Describes a brokerage that SnapTrade supports.
   class Brokerage
+    # Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
     attr_accessor :id
 
+    # A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
+    attr_accessor :slug
+
     # Full name of the brokerage.
     attr_accessor :name
 
     # A display-friendly name of the brokerage.
     attr_accessor :display_name
 
+    # A brief description of the brokerage.
     attr_accessor :description
 
+    # URL to the brokerage's logo.
     attr_accessor :aws_s3_logo_url
 
+    # URL to the brokerage's logo in square format.
     attr_accessor :aws_s3_square_logo_url
 
+    # This field is deprecated.
     attr_accessor :open_url
 
-    # A unique identifier for that brokerage. It is usually the name of the brokerage in capital letters and will never change.
-    attr_accessor :slug
-
+    # URL to the brokerage's website.
     attr_accessor :url
 
+    # Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
     attr_accessor :enabled
 
+    # Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
     attr_accessor :maintenance_mode
 
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :allows_fractional_units
 
+    # Whether the brokerage allows trading through SnapTrade.
     attr_accessor :allows_trading
 
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :has_reporting
 
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :is_real_time_connection
 
-    attr_accessor :allows_trading_through_snaptrade_api
-
-    attr_accessor :is_scraping_integration
-
-    attr_accessor :default_currency
-
     attr_accessor :brokerage_type
 
-    # List of exchange ID supported by brokerage
+    # This field is deprecated. Please contact us if you have a valid use case for it.
     attr_accessor :exchanges
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
+        :'slug' => :'slug',
         :'name' => :'name',
         :'display_name' => :'display_name',
         :'description' => :'description',
         :'aws_s3_logo_url' => :'aws_s3_logo_url',
         :'aws_s3_square_logo_url' => :'aws_s3_square_logo_url',
         :'open_url' => :'open_url',
-        :'slug' => :'slug',
         :'url' => :'url',
         :'enabled' => :'enabled',
         :'maintenance_mode' => :'maintenance_mode',
@@ -74,9 +81,6 @@ module SnapTrade
         :'allows_trading' => :'allows_trading',
         :'has_reporting' => :'has_reporting',
         :'is_real_time_connection' => :'is_real_time_connection',
-        :'allows_trading_through_snaptrade_api' => :'allows_trading_through_snaptrade_api',
-        :'is_scraping_integration' => :'is_scraping_integration',
-        :'default_currency' => :'default_currency',
         :'brokerage_type' => :'brokerage_type',
         :'exchanges' => :'exchanges'
       }
@@ -91,13 +95,13 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
+        :'slug' => :'String',
         :'name' => :'String',
         :'display_name' => :'String',
         :'description' => :'String',
         :'aws_s3_logo_url' => :'String',
         :'aws_s3_square_logo_url' => :'String',
         :'open_url' => :'String',
-        :'slug' => :'String',
         :'url' => :'String',
         :'enabled' => :'Boolean',
         :'maintenance_mode' => :'Boolean',
@@ -105,9 +109,6 @@ module SnapTrade
         :'allows_trading' => :'Boolean',
         :'has_reporting' => :'Boolean',
         :'is_real_time_connection' => :'Boolean',
-        :'allows_trading_through_snaptrade_api' => :'Boolean',
-        :'is_scraping_integration' => :'Boolean',
-        :'default_currency' => :'String',
         :'brokerage_type' => :'BrokerageType',
         :'exchanges' => :'Array<Object>'
       }
@@ -121,7 +122,6 @@ module SnapTrade
         :'allows_fractional_units',
         :'allows_trading',
         :'has_reporting',
-        :'allows_trading_through_snaptrade_api',
       ])
     end
 
@@ -144,6 +144,10 @@ module SnapTrade
         self.id = attributes[:'id']
       end
 
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -168,10 +172,6 @@ module SnapTrade
         self.open_url = attributes[:'open_url']
       end
 
-      if attributes.key?(:'slug')
-        self.slug = attributes[:'slug']
-      end
-
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -200,18 +200,6 @@ module SnapTrade
         self.is_real_time_connection = attributes[:'is_real_time_connection']
       end
 
-      if attributes.key?(:'allows_trading_through_snaptrade_api')
-        self.allows_trading_through_snaptrade_api = attributes[:'allows_trading_through_snaptrade_api']
-      end
-
-      if attributes.key?(:'is_scraping_integration')
-        self.is_scraping_integration = attributes[:'is_scraping_integration']
-      end
-
-      if attributes.key?(:'default_currency')
-        self.default_currency = attributes[:'default_currency']
-      end
-
       if attributes.key?(:'brokerage_type')
         self.brokerage_type = attributes[:'brokerage_type']
       end
@@ -242,13 +230,13 @@ module SnapTrade
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          slug == o.slug &&
           name == o.name &&
           display_name == o.display_name &&
           description == o.description &&
           aws_s3_logo_url == o.aws_s3_logo_url &&
           aws_s3_square_logo_url == o.aws_s3_square_logo_url &&
           open_url == o.open_url &&
-          slug == o.slug &&
           url == o.url &&
           enabled == o.enabled &&
           maintenance_mode == o.maintenance_mode &&
@@ -256,9 +244,6 @@ module SnapTrade
           allows_trading == o.allows_trading &&
           has_reporting == o.has_reporting &&
           is_real_time_connection == o.is_real_time_connection &&
-          allows_trading_through_snaptrade_api == o.allows_trading_through_snaptrade_api &&
-          is_scraping_integration == o.is_scraping_integration &&
-          default_currency == o.default_currency &&
           brokerage_type == o.brokerage_type &&
           exchanges == o.exchanges
     end
@@ -272,7 +257,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, display_name, description, aws_s3_logo_url, aws_s3_square_logo_url, open_url, slug, url, enabled, maintenance_mode, allows_fractional_units, allows_trading, has_reporting, is_real_time_connection, allows_trading_through_snaptrade_api, is_scraping_integration, default_currency, brokerage_type, exchanges].hash
+      [id, slug, name, display_name, description, aws_s3_logo_url, aws_s3_square_logo_url, open_url, url, enabled, maintenance_mode, allows_fractional_units, allows_trading, has_reporting, is_real_time_connection, brokerage_type, exchanges].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/brokerage_authorization.rb

@@ -11,28 +11,32 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # A single connection with a brokerage. 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. 
   class BrokerageAuthorization
+    # Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
     attr_accessor :id
 
-    # Time
+    # Timestamp of when the connection was established in SnapTrade.
     attr_accessor :created_date
 
-    # Time
+    # Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
     attr_accessor :updated_date
 
     attr_accessor :brokerage
 
-    # Connection Name
+    # A short, human-readable name for the connection.
     attr_accessor :name
 
+    # Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`.
     attr_accessor :type
 
+    # Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios:  - The user has changed their username or password at the brokerage. - The user has explicitly removed the access grant at the brokerage. - The session has expired at the brokerage and now requires explicit user re-authentication.  Please see [this guide](https://docs.snaptrade.com/docs/fix-broken-connections) on how to fix a disabled connection. 
     attr_accessor :disabled
 
-    # Disabled date
+    # Timestamp of when the connection was disabled in SnapTrade.
     attr_accessor :disabled_date
 
-    # Additional data about brokerage authorization
+    # Additional data about the connection. 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -59,13 +63,13 @@ module SnapTrade
     def self.openapi_types
       {
         :'id' => :'String',
-        :'created_date' => :'String',
-        :'updated_date' => :'String',
+        :'created_date' => :'Time',
+        :'updated_date' => :'Time',
         :'brokerage' => :'Brokerage',
         :'name' => :'String',
         :'type' => :'String',
         :'disabled' => :'Boolean',
-        :'disabled_date' => :'String',
+        :'disabled_date' => :'Time',
         :'meta' => :'Hash<String, Object>'
       }
     end

data/lib/snaptrade/models/brokerage_authorization_disabled_confirmation.rb

@@ -11,6 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # Confirmation that the connection has been disabled.
   class BrokerageAuthorizationDisabledConfirmation
     # Connection disabled confirmation
     attr_accessor :detail

data/lib/snaptrade/models/brokerage_authorization_refresh_confirmation.rb

@@ -11,6 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
+  # Confirmation that the syncs have been scheduled.
   class BrokerageAuthorizationRefreshConfirmation
     # Refresh confirmation details
     attr_accessor :detail

data/lib/snaptrade/models/brokerage_type.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Type of brokerage
+  # Type of brokerage. Currently supports traditional brokerages and crypto exchanges.
   class BrokerageType
     attr_accessor :id
 

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -115,7 +115,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for list_user_accounts
   # 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 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/api/authentication_api_spec.rb

@@ -41,7 +41,7 @@ describe 'AuthenticationApi' do
 
   # unit tests for list_snap_trade_users
   # 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>]
   describe 'list_snap_trade_users test' do

data/spec/api/connections_api_spec.rb

@@ -28,9 +28,9 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for detail_brokerage_authorization
-  # Get brokerage authorization details
-  # Returns a single brokerage authorization object for the specified ID.
-  # @param authorization_id The ID of a brokerage authorization object.
+  # Get connection detail
+  # Returns a single connection for the specified ID.
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -42,9 +42,9 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for disable_brokerage_authorization
-  # Manually disable a connection for testing
-  # 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.
-  # @param authorization_id The ID of a brokerage authorization object.
+  # Force disable connection
+  # 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.* 
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -56,8 +56,8 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for list_brokerage_authorizations
-  # List all brokerage authorizations for the User
-  # Returns a list of Brokerage Authorization objects for the user
+  # List all connections
+  # 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. 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -70,8 +70,8 @@ describe 'ConnectionsApi' do
 
   # unit tests for refresh_brokerage_authorization
   # Refresh holdings for a connection
-  # Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
-  # @param authorization_id The ID of a brokerage authorization object.
+  # 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.* 
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters
@@ -83,9 +83,9 @@ describe 'ConnectionsApi' do
   end
 
   # unit tests for remove_brokerage_authorization
-  # Delete brokerage authorization
-  # Deletes a specified brokerage authorization given by the ID.
-  # @param authorization_id The ID of the Authorization to delete.
+  # Delete connection
+  # 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.
+  # @param authorization_id 
   # @param user_id 
   # @param user_secret 
   # @param [Hash] opts the optional parameters

data/spec/models/brokerage_spec.rb

@@ -26,6 +26,12 @@ describe SnapTrade::Brokerage do
     end
   end
 
+  describe 'test attribute "slug"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "name"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -62,12 +68,6 @@ describe SnapTrade::Brokerage do
     end
   end
 
-  describe 'test attribute "slug"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   describe 'test attribute "url"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -110,24 +110,6 @@ describe SnapTrade::Brokerage do
     end
   end
 
-  describe 'test attribute "allows_trading_through_snaptrade_api"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "is_scraping_integration"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "default_currency"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   describe 'test attribute "brokerage_type"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.37
+  version: 2.0.38
 platform: ruby
 authors:
 - SnapTrade