snaptrade-typescript-sdk 13.1.10 → 13.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -63,7 +63,7 @@ backoff with jitter rather than from the headers.
63
63
  See https://docs.snaptrade.com/docs/ratelimiting.
64
64
 
65
65
 
66
- [![npm](https://img.shields.io/badge/npm-v13.1.10-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/13.1.10)
66
+ [![npm](https://img.shields.io/badge/npm-v13.1.12-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/13.1.12)
67
67
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
68
68
 
69
69
  </div>
@@ -516,7 +516,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
516
516
 
517
517
  ### `snaptrade.accountInformation.getAccountDetails`<a id="snaptradeaccountinformationgetaccountdetails"></a>
518
518
 
519
- Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account.
519
+ Returns the specified account for the authenticated user. The account can be an investment, deposit, line of credit, or annuity account. Use the `kind` discriminator to determine the schema for the account.
520
520
 
521
521
  On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
522
522
 
@@ -698,7 +698,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
698
698
  ### `snaptrade.accountInformation.getUserAccountDetails`<a id="snaptradeaccountinformationgetuseraccountdetails"></a>
699
699
  ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
700
700
 
701
- **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, and line of credit accounts.
701
+ **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, line of credit, and annuity accounts.
702
702
 
703
703
  Returns account detail known to SnapTrade for the specified account.
704
704
 
@@ -1084,7 +1084,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
1084
1084
 
1085
1085
  Returns all accounts across all connections known to SnapTrade for the authenticated user.
1086
1086
 
1087
- The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
1087
+ The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and annuity accounts. Use the `kind` discriminator to determine the schema for each account.
1088
1088
 
1089
1089
  This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
1090
1090
 
@@ -1133,7 +1133,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
1133
1133
  ### `snaptrade.accountInformation.listUserAccounts`<a id="snaptradeaccountinformationlistuseraccounts"></a>
1134
1134
  ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
1135
1135
 
1136
- **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, and line of credit accounts.
1136
+ **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, line of credit, and annuity accounts.
1137
1137
 
1138
1138
  Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
1139
1139
 
@@ -1774,7 +1774,7 @@ The client identifies the user in this mode. Do not pass `userId` `userSecret` t
1774
1774
 
1775
1775
  Returns all accounts that belong to the specified connection for the authenticated user.
1776
1776
 
1777
- The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.
1777
+ The `results` list can contain multiple account types in the same response, including investment, deposit, line of credit, and annuity accounts. Use the `kind` discriminator to determine the schema for each account.
1778
1778
 
1779
1779
  On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.
1780
1780