snaptrade 2.0.33 → 2.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5850595b939dd6002902054531b756f0355f067082c8f22428ef8d2ed0fe8cca
-  data.tar.gz: 1558b337647677cc79abda65377e9bdca6a70caae86ec26742d37eb4d33d578f
+  metadata.gz: 412464fcddf65f80c586296c40db02443337c3b5c9b73ce2a2e8e4f81c891aeb
+  data.tar.gz: e7e919ba8ad6b10761c8a3e1b91533476505f4f07182d3a7537ebdcaef635103
 SHA512:
-  metadata.gz: 7db59e62afd2e024cf15723d2385a7374ac2660561eea3e30fa46ca0acdabc7bc563060776e44e9291b6b5f0755f50764b44f24151e023c5f4f216b757a163de
-  data.tar.gz: 8d373f45a9e72438a8de270fa118c399b8e8dbce9d63e11136c22eccf0d0226f7c2b739325be1d3ed4c8803a3a0efaeb47d0e9af6b76c588f39cf9dfdfe62e08
+  metadata.gz: 538898f098a7968e48652fd208d7a1991957786d042babc3a90642ddf8a909b23329eb66bd10bdda24511314648a90ff9d3edb48a48e107d9f8afcf8ff7dba62
+  data.tar.gz: 1dd27dcf92043d041ef2f9e5bf915dcff7b9ecb504c29c8d458ce32017bc19e91febb42572a80ed4f0c9e1d1a6d0ba15486caf5aeaa16dcaf4406df4e07a3cad

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.33)
+    snaptrade (2.0.35)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -28,7 +28,7 @@ GEM
       reline (>= 0.3.0)
     method_source (1.1.0)
     multipart-post (2.4.1)
-    parallel (1.26.2)
+    parallel (1.26.3)
     parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
@@ -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.33-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.33)
+[![npm](https://img.shields.io/badge/gem-v2.0.35-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.35)
 [![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.33'
+gem 'snaptrade', '~> 2.0.35'
 ```
 
 ## 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>
@@ -152,7 +152,10 @@ needed on one or more authorizations).
 
 ### `snaptrade.account_information.get_user_account_balance`<a id="snaptradeaccount_informationget_user_account_balance"></a>
 
-A list of account balances for the specified account (one per currency that the account holds).
+Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
+
+The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -170,8 +173,6 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to get balances.
-
 #### 🔄 Return<a id="🔄-return"></a>
 
 [Balance](./lib/snaptrade/models/balance.rb)
@@ -187,8 +188,9 @@ The ID of the account to get balances.
 
 ### `snaptrade.account_information.get_user_account_details`<a id="snaptradeaccount_informationget_user_account_details"></a>
 
-Returns an account object with details for the specified account,
-including the total account market value.
+Returns account detail known to SnapTrade for the specified account.
+
+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>
@@ -207,8 +209,6 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to get detail of.
-
 #### 🔄 Return<a id="🔄-return"></a>
 
 [Account](./lib/snaptrade/models/account.rb)
@@ -224,7 +224,10 @@ The ID of the account to get detail of.
 
 ### `snaptrade.account_information.get_user_account_orders`<a id="snaptradeaccount_informationget_user_account_orders"></a>
 
-Fetch all recent orders from a user's account.
+Returns a list of recent orders in the specified account.
+
+The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -244,8 +247,6 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to get orders.
-
 ##### state: `String`<a id="state-string"></a>
 defaults value is set to \"all\"
 
@@ -268,7 +269,10 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
 
 ### `snaptrade.account_information.get_user_account_positions`<a id="snaptradeaccount_informationget_user_account_positions"></a>
 
-Returns a list of positions in the specified account.
+Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).
+
+The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -286,8 +290,6 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to get positions.
-
 #### 🔄 Return<a id="🔄-return"></a>
 
 [Position](./lib/snaptrade/models/position.rb)
@@ -303,7 +305,7 @@ The ID of the account to get positions.
 
 ### `snaptrade.account_information.get_user_holdings`<a id="snaptradeaccount_informationget_user_holdings"></a>
 
-Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
+Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
 
 The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
 
@@ -339,7 +341,10 @@ p result
 
 ### `snaptrade.account_information.list_user_accounts`<a id="snaptradeaccount_informationlist_user_accounts"></a>
 
-Get a list of all Account objects for the authenticated SnapTrade user.
+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**.
+
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -429,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>
 
@@ -458,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>
 
@@ -491,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
 ```
@@ -501,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>
 
@@ -574,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>
@@ -598,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>
 
@@ -798,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>
@@ -947,7 +961,9 @@ Option strategy id obtained from response when creating option strategy object
 
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
-Returns a list of Options Positions.
+Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
+
+The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -956,7 +972,7 @@ Returns a list of Options Positions.
 result = snaptrade.options.list_option_holdings(
   user_id: "snaptrade-user-123",
   user_secret: "USERSECRET123",
-  account_id: "accountId_example",
+  account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
 )
 p result
 ```
@@ -966,8 +982,6 @@ p result
 ##### user_id: `String`<a id="user_id-string"></a>
 ##### user_secret: `String`<a id="user_secret-string"></a>
 ##### account_id: `String`<a id="account_id-string"></a>
-The ID of the account to fetch options holdings for.
-
 #### 🔄 Return<a id="🔄-return"></a>
 
 [OptionsPosition](./lib/snaptrade/models/options_position.rb)
@@ -1590,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>
 
@@ -1602,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
 ```
@@ -1612,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>
 
@@ -1671,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>