snaptrade-typescript-sdk 12.1.3 → 12.1.5

package/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/npm-v12.1.3-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/12.1.3)
+[![npm](https://img.shields.io/badge/npm-v12.1.5-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/12.1.5)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -27,6 +27,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.accountInformation.getUserAccountOrders`](#snaptradeaccountinformationgetuseraccountorders)
   * [`snaptrade.accountInformation.getUserAccountRecentOrders`](#snaptradeaccountinformationgetuseraccountrecentorders)
   * [`snaptrade.accountInformation.getUserAccountReturnRates`](#snaptradeaccountinformationgetuseraccountreturnrates)
+  * [`snaptrade.accountInformation.getUserAumPercentile`](#snaptradeaccountinformationgetuseraumpercentile)
   * [`snaptrade.accountInformation.getUserHoldings`](#snaptradeaccountinformationgetuserholdings)
   * [`snaptrade.accountInformation.listUserAccounts`](#snaptradeaccountinformationlistuseraccounts)
   * [`snaptrade.accountInformation.updateUserAccount`](#snaptradeaccountinformationupdateuseraccount)
@@ -573,6 +574,35 @@ Optional comma separated list of rate-of-return timeframes to return. Supported
 ---
 
 
+### `snaptrade.accountInformation.getUserAumPercentile`<a id="snaptradeaccountinformationgetuseraumpercentile"></a>
+
+Returns where the user's total assets sit within the distribution of a cohort of comparable users, as a coarse bucket plus an integer percentile.
+
+The cohort is scoped to your own book: a user is only ever compared against your other users, never across SnapTrade customers. (Users on personal-use keys are the exception — they are compared against all other personal-use users, since a personal key has a single user and cannot form a distribution of its own.) The distribution is recomputed monthly, and `as_of` reports which month's distribution the placement came from.
+
+`data` is `null` — a 200, not an error — when SnapTrade declines to place the user. That happens when the cohort is too small to publish a distribution, or when the user's own holdings are incomplete or stale (for example they hold a disabled connection). A placement computed from a partial view of a user's assets would understate them, so none is returned.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```typescript
+const getUserAumPercentileResponse =
+  await snaptrade.accountInformation.getUserAumPercentile();
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[UserAumPercentileResponse](./models/user-aum-percentile-response.ts)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/aumPercentile` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.accountInformation.getUserHoldings`<a id="snaptradeaccountinformationgetuserholdings"></a>
 ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
 
@@ -760,6 +790,7 @@ const loginSnapTradeUserResponse =
     connectionType: "read",
     showCloseButton: true,
     darkMode: true,
+    locale: "pt-BR",
     connectionPortalVersion: "v4",
   });
 ```
@@ -794,6 +825,10 @@ Controls whether the close (X) button is displayed in the connection portal. Whe
 
 Enable dark mode for the connection portal. Defaults to false.
 
+##### locale: `string`<a id="locale-string"></a>
+
+Language the connection portal renders in. `en` and `pt-BR` are the languages we ship; any other language is rejected with a 400. Matching is case- and separator-insensitive, so `pt-br`, `pt-BR` and `pt_BR` are equivalent, and a regional tag resolves to the language when we ship it, so `en-US` renders `en`. Deliberately not an enum: those equivalent spellings are all accepted by the API, and an enum would have generated SDKs reject them before the request is sent. Screens without translated copy fall back to English individually. Defaults to `en`. 
+
 ##### connectionPortalVersion: `string`<a id="connectionportalversion-string"></a>
 
 Sets the connection portal version to render. Currently only `v4` is supported and is the default. All other versions are deprecated and will automatically be set to v4.
@@ -1347,9 +1382,9 @@ Experimental and subject to change without notice.
 
 Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape.
 
-Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.
+Each item in the response carries a `kind` field (currently `investment` and `deposit` are implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema.
 
-On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and market value live from the brokerage on each call.
+On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total balance (`market_value` for `investment`, `balance` for `deposit`) live from the brokerage on each call, along with funding date for `investment` accounts.
 
 On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).