snaptrade 2.0.34 → 2.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 970b9a64740174d662e372bcda27e6a8abf2d4c19f70abca63b55ecd4a5e6df5
-  data.tar.gz: b7b0f1b0b0510932f1e9d1e02db3fb52678e03057b02065dce9f26507cf3496c
+  metadata.gz: 7e8a3e30ce711edef7835ce59691c2709524f4d40add0b1913146ac04a56efaf
+  data.tar.gz: 1ceed48b23a0c73555e2f13804dbeb51b819d2c39dca6edef6314674aae99ca2
 SHA512:
-  metadata.gz: 4f59d7b0412ac4116df910ac089f2dce01214a072922c5e00c66b8f904a34ba88e4e4335f490547c71cd4f5d94e2154a28ff82931eed5ccbd0d86e28b6947708
-  data.tar.gz: fe2e89d41ba0f9ce682c1e3813162ca60440ec80100e75f05a7e29c2c9a756ad7ea51fb673b3b679b78ce6cd5aaa177d0bb1ad5ae1b736e5887360aeca8f44f8
+  metadata.gz: 35df36a5be0fd0f2885229ee237b7938073703d7eb9878a4b77092a9dc6964afbeed9da5454434e02a3e45af466bff57ad9f8e25fe11c254cb6c2cc9ac17c8f7
+  data.tar.gz: c3e1f881f4509c8a8617e32c7cd25d583cba44c0e11b4633464867af8fed1ac592183645d6faf6594c671d6c1d5618afee35deb8ab92ba8e728b4a3c4af43f8b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.34)
+    snaptrade (2.0.36)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -68,7 +68,7 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.32.0)
+    rubocop-ast (1.32.1)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)

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.34-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.34)
+[![npm](https://img.shields.io/badge/gem-v2.0.36-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.36)
 [![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.34'
+gem 'snaptrade', '~> 2.0.36'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -134,7 +134,7 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### brokerage_authorizations: `String`<a id="brokerage_authorizations-string"></a>
-Optional. Comma seperated list of authorization IDs (only use if filtering is
+Optional. Comma separated list of authorization IDs (only use if filtering is
 needed on one or more authorizations).
 
 #### 🔄 Return<a id="🔄-return"></a>
@@ -434,7 +434,7 @@ p result
 
 ### `snaptrade.authentication.delete_snap_trade_user`<a id="snaptradeauthenticationdelete_snap_trade_user"></a>
 
-Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -463,7 +463,7 @@ p result
 
 ### `snaptrade.authentication.list_snap_trade_users`<a id="snaptradeauthenticationlist_snap_trade_users"></a>
 
-Returns a list of users you've registered over the SnapTrade API.
+Returns a list of all registered user IDs.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -496,7 +496,7 @@ result = snaptrade.authentication.login_snap_trade_user(
   custom_redirect: "https://snaptrade.com",
   reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
   connection_type: "read",
-  connection_portal_version: "v2",
+  connection_portal_version: "v3",
 )
 p result
 ```
@@ -506,27 +506,36 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### broker: `String`<a id="broker-string"></a>
-Slug of the brokerage to connect the user to. See [this
-document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead)
+Slug of the brokerage to connect the user to. See [the integrations
+page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4)
 for a list of supported brokerages and their slugs.
 
 ##### immediateRedirect: `Boolean`<a id="immediateredirect-boolean"></a>
-When set to True, user will be redirected back to the partner's site instead of
-the connection portal
+When set to `true`, user will be redirected back to the partner's site instead
+of the connection portal. This parameter is ignored if the connection portal is
+loaded inside an iframe. See the [guide on ways to integrate the connection
+portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more
+information.
 
 ##### customRedirect: `String`<a id="customredirect-string"></a>
-URL to redirect the user to after the user connects their brokerage account
+URL to redirect the user to after the user connects their brokerage account.
+This parameter is ignored if the connection portal is loaded inside an iframe.
+See the [guide on ways to integrate the connection
+portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more
+information.
 
 ##### reconnect: `String`<a id="reconnect-string"></a>
 The UUID of the brokerage connection to be reconnected. This parameter should be
-left empty unless you are reconnecting a disabled connection. See ‘Reconnecting
-Accounts’ for more information.
+left empty unless you are reconnecting a disabled connection. See the [guide on
+fixing broken
+connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more
+information.
 
 ##### connectionType: [`ConnectionType`](./lib/snaptrade/models/connection_type.rb)<a id="connectiontype-connectiontypelibsnaptrademodelsconnection_typerb"></a>
-Sets whether the connection should be read or trade
+Sets whether the connection should be read-only or trade-enabled.
 
 ##### connectionPortalVersion: [`ConnectionPortalVersion`](./lib/snaptrade/models/connection_portal_version.rb)<a id="connectionportalversion-connectionportalversionlibsnaptrademodelsconnection_portal_versionrb"></a>
-Sets the version of the connection portal to render, with a default to 'v3'
+Sets the version of the connection portal to render.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -579,8 +588,7 @@ immutable.
 
 ### `snaptrade.authentication.reset_snap_trade_user_secret`<a id="snaptradeauthenticationreset_snap_trade_user_secret"></a>
 
-This API is used to rotate the secret for a SnapTrade user. You might use this if a 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.
+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.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -603,7 +611,8 @@ 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 SnapTrade API.
+information and if compromised, should be rotated via the [rotate user secret
+endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -803,11 +812,11 @@ p result
 
 ##### partner_client_id: `String`<a id="partner_client_id-string"></a>
 ##### user_id: `String`<a id="user_id-string"></a>
-Optional comma seperated list of user IDs used to filter the request on specific
+Optional comma separated list of user IDs used to filter the request on specific
 users
 
 ##### session_id: `String`<a id="session_id-string"></a>
-Optional comma seperated list of session IDs used to filter the request on
+Optional comma separated list of session IDs used to filter the request on
 specific users
 
 #### 🔄 Return<a id="🔄-return"></a>
@@ -1595,7 +1604,12 @@ responding to the request
 
 ### `snaptrade.transactions_and_reporting.get_activities`<a id="snaptradetransactions_and_reportingget_activities"></a>
 
-Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+
+There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+
+The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1607,7 +1621,7 @@ result = snaptrade.transactions_and_reporting.get_activities(
   end_date: "2022-01-24",
   accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
   brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
-  type: "DIVIDEND",
+  type: "BUY,SELL,DIVIDEND",
 )
 p result
 ```
@@ -1617,24 +1631,32 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### start_date: `Date`<a id="start_date-date"></a>
+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`.
+
 ##### end_date: `Date`<a id="end_date-date"></a>
+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`.
+
 ##### accounts: `String`<a id="accounts-string"></a>
-Optional comma seperated list of account IDs used to filter the request on
-specific 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.
 
 ##### brokerage_authorizations: `String`<a id="brokerage_authorizations-string"></a>
-Optional comma seperated list of brokerage authorization IDs used to filter the
-request on only accounts that belong to those 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.
 
 ##### type: `String`<a id="type-string"></a>
-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
+Optional comma separated list of transaction types to filter by. SnapTrade does
+a best effort to categorize brokerage transaction types into a common set of
+values. Here are some of the most popular values: - BUY - SELL - DIVIDEND -
+CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1676,7 +1698,7 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### accounts: `String`<a id="accounts-string"></a>
-Optional comma seperated list of account IDs used to filter the request on
+Optional comma separated list of account IDs used to filter the request on
 specific accounts
 
 ##### detailed: `Boolean`<a id="detailed-boolean"></a>

data/lib/snaptrade/api/account_information_api.rb

@@ -26,7 +26,7 @@ module SnapTrade
     #
     # @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 brokerage_authorizations [String] Optional. Comma separated 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
     def get_all_user_holdings(user_id:, user_secret:, brokerage_authorizations: SENTINEL, extra: {})
       extra[:brokerage_authorizations] = brokerage_authorizations if brokerage_authorizations != SENTINEL
@@ -43,7 +43,7 @@ module SnapTrade
     #
     # @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 brokerage_authorizations [String] Optional. Comma separated 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
     def get_all_user_holdings_with_http_info(user_id:, user_secret:, brokerage_authorizations: SENTINEL, extra: {})
       extra[:brokerage_authorizations] = brokerage_authorizations if brokerage_authorizations != SENTINEL
@@ -55,7 +55,7 @@ module SnapTrade
     # @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).
+    # @option opts [String] :brokerage_authorizations Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
     # @return [Array<AccountHoldings>]
     private def get_all_user_holdings_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = get_all_user_holdings_with_http_info(user_id, user_secret, opts)
@@ -67,7 +67,7 @@ module SnapTrade
     # @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).
+    # @option opts [String] :brokerage_authorizations Optional. Comma separated 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
     private def get_all_user_holdings_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging

data/lib/snaptrade/api/authentication_api.rb

@@ -17,9 +17,9 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Delete SnapTrade user
+    # Delete user
     #
-    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+    # Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
     #
     # @param user_id [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -28,9 +28,9 @@ module SnapTrade
       data
     end
 
-    # Delete SnapTrade user
+    # Delete user
     #
-    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+    # Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
     #
     # @param user_id [String] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -38,8 +38,8 @@ module SnapTrade
       delete_snap_trade_user_with_http_info_impl(user_id, extra)
     end
 
-    # Delete SnapTrade user
-    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+    # Delete user
+    # Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [DeleteUserResponse]
@@ -48,8 +48,8 @@ module SnapTrade
       data
     end
 
-    # Delete SnapTrade user
-    # Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.
+    # Delete user
+    # Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a `USER_DELETED` webhook will be sent.
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeleteUserResponse, Integer, Hash)>] DeleteUserResponse data, response status code and response headers
@@ -103,9 +103,9 @@ module SnapTrade
     end
 
 
-    # List SnapTrade users
+    # List all users
     #
-    # Returns a list of users you've registered over the SnapTrade API.
+    # Returns a list of all registered user IDs.
     #
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def list_snap_trade_users(extra: {})
@@ -113,17 +113,17 @@ module SnapTrade
       data
     end
 
-    # List SnapTrade users
+    # List all users
     #
-    # Returns a list of users you've registered over the SnapTrade API.
+    # Returns a list of all registered user IDs.
     #
     # @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: {})
       list_snap_trade_users_with_http_info_impl(extra)
     end
 
-    # List SnapTrade users
-    # Returns a list of users you've registered over the SnapTrade API.
+    # List all users
+    # Returns a list of all registered user IDs.
     # @param [Hash] opts the optional parameters
     # @return [Array<String>]
     private def list_snap_trade_users_impl(opts = {})
@@ -131,8 +131,8 @@ module SnapTrade
       data
     end
 
-    # List SnapTrade users
-    # Returns a list of users you&#39;ve registered over the SnapTrade API.
+    # List all users
+    # Returns a list of all registered user IDs.
     # @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 = {})
@@ -186,15 +186,15 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
-    # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
-    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
-    # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
-    # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
-    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v3'
+    # @param broker [String] Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
+    # @param immediate_redirect [Boolean] When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
+    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more information.
+    # @param connection_type [ConnectionType] Sets whether the connection should be read-only or trade-enabled.
+    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render.
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
+    def login_snap_trade_user(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: 'read', connection_portal_version: 'v3', extra: {})
       _body = {}
       _body[:broker] = broker if broker != SENTINEL
       _body[:immediateRedirect] = immediate_redirect if immediate_redirect != SENTINEL
@@ -213,15 +213,15 @@ module SnapTrade
     #
     # @param user_id [String] 
     # @param user_secret [String] 
-    # @param broker [String] Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
-    # @param immediate_redirect [Boolean] When set to True, user will be redirected back to the partner's site instead of the connection portal
-    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account
-    # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
-    # @param connection_type [ConnectionType] Sets whether the connection should be read or trade
-    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render, with a default to 'v3'
+    # @param broker [String] Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
+    # @param immediate_redirect [Boolean] When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
+    # @param custom_redirect [String] URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
+    # @param reconnect [String] The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more information.
+    # @param connection_type [ConnectionType] Sets whether the connection should be read-only or trade-enabled.
+    # @param connection_portal_version [ConnectionPortalVersion] Sets the version of the connection portal to render.
     # @param body [SnapTradeLoginUserRequestBody] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: SENTINEL, connection_portal_version: SENTINEL, extra: {})
+    def login_snap_trade_user_with_http_info(user_id:, user_secret:, broker: SENTINEL, immediate_redirect: SENTINEL, custom_redirect: SENTINEL, reconnect: SENTINEL, connection_type: 'read', connection_portal_version: 'v3', extra: {})
       _body = {}
       _body[:broker] = broker if broker != SENTINEL
       _body[:immediateRedirect] = immediate_redirect if immediate_redirect != SENTINEL
@@ -312,7 +312,7 @@ module SnapTrade
     end
 
 
-    # Create SnapTrade user
+    # 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.
@@ -328,7 +328,7 @@ module SnapTrade
       data
     end
 
-    # Create SnapTrade user
+    # 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.
@@ -343,7 +343,7 @@ module SnapTrade
       register_snap_trade_user_with_http_info_impl(snap_trade_register_user_request_body, extra)
     end
 
-    # Create SnapTrade user
+    # 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. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
@@ -353,7 +353,7 @@ module SnapTrade
       data
     end
 
-    # Create SnapTrade user
+    # 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. 
     # @param snap_trade_register_user_request_body [SnapTradeRegisterUserRequestBody] 
     # @param [Hash] opts the optional parameters
@@ -412,13 +412,12 @@ module SnapTrade
     end
 
 
-    # Obtain a new user secret for a user
+    # Rotate user secret
     #
-    # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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.
+    # 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 SnapTrade API.
+    # @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 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: {})
@@ -430,13 +429,12 @@ module SnapTrade
       data
     end
 
-    # Obtain a new user secret for a user
+    # Rotate user secret
     #
-    # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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.
+    # 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 SnapTrade API.
+    # @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 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: {})
@@ -447,8 +445,8 @@ module SnapTrade
       reset_snap_trade_user_secret_with_http_info_impl(user_i_dand_secret, extra)
     end
 
-    # Obtain a new user secret for a user
-    # This API is used to rotate the secret for a SnapTrade user. You might use this if a 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. 
+    # Rotate user secret
+    # 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_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [UserIDandSecret]
@@ -457,8 +455,8 @@ module SnapTrade
       data
     end
 
-    # Obtain a new user secret for a user
-    # This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you&#39;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. 
+    # Rotate user secret
+    # Rotates the secret for a SnapTrade user. You might use this if &#x60;userSecret&#x60; is compromised. Please note that if you call this endpoint and fail to save the new secret, you&#39;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_i_dand_secret [UserIDandSecret] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserIDandSecret, Integer, Hash)>] UserIDandSecret data, response status code and response headers

data/lib/snaptrade/api/connections_api.rb

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