snaptrade-typescript-sdk 9.0.34 → 9.0.35

package/dist/configuration.js

@@ -32,7 +32,7 @@ class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.34/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.35/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/account-balance-total.d.ts

@@ -1,5 +1,5 @@
 /**
- * Total value of this account (includes cash, equity, fixed income, etc)
+ * Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account.
  * @export
  * @interface AccountBalanceTotal
  */

package/dist/models/account-holdings-account.d.ts

@@ -1,8 +1,8 @@
+import { Account } from './account';
 import { AccountOrderRecord } from './account-order-record';
 import { Balance } from './balance';
 import { OptionsPosition } from './options-position';
 import { Position } from './position';
-import { SnapTradeHoldingsAccountAccountId } from './snap-trade-holdings-account-account-id';
 import { SnapTradeHoldingsTotalValue } from './snap-trade-holdings-total-value';
 /**
  * A wrapper object containing holdings information for a single account.
@@ -13,10 +13,10 @@ export interface AccountHoldingsAccount {
     [key: string]: any;
     /**
      *
-     * @type {SnapTradeHoldingsAccountAccountId}
+     * @type {Account}
      * @memberof AccountHoldingsAccount
      */
-    'account'?: SnapTradeHoldingsAccountAccountId;
+    'account'?: Account;
     /**
      * 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).
      * @type {Array<Balance>}

package/dist/models/account-sync-status.d.ts

@@ -1,7 +1,7 @@
 import { HoldingsStatus } from './holdings-status';
 import { TransactionsStatus } from './transactions-status';
 /**
- * Status of account
+ * Contains status update for the account sync process between SnapTrade and the brokerage.
  * @export
  * @interface AccountSyncStatus
  */

package/dist/models/account.d.ts

@@ -1,58 +1,60 @@
 import { AccountBalance } from './account-balance';
 import { AccountSyncStatus } from './account-sync-status';
 /**
- * SnapTradeUser Investment Account
+ * A single brokerage account at a financial institution.
  * @export
  * @interface Account
  */
 export interface Account {
     [key: string]: any;
     /**
-     *
+     * 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. If you want a stable identifier for the account, use the `number` field.
      * @type {string}
      * @memberof Account
      */
     'id'?: string;
     /**
-     *
+     * Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
      * @type {string}
      * @memberof Account
      */
     'brokerage_authorization'?: string;
     /**
-     *
+     * Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
      * @type {string}
      * @memberof Account
+     * @deprecated
      */
     'portfolio_group'?: string;
     /**
-     *
+     * A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
      * @type {string}
      * @memberof Account
      */
-    'name'?: string;
+    'name'?: string | null;
     /**
-     *
+     * The account number assigned by the financial institution.
      * @type {string}
      * @memberof Account
      */
     'number'?: string;
     /**
-     *
+     * The name of the financial institution that holds the account.
      * @type {string}
      * @memberof Account
      */
     'institution_name'?: string;
     /**
-     *
+     * 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 financial institution.
      * @type {string}
      * @memberof Account
      */
     'created_date'?: string;
     /**
-     *
+     * Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there\'s no standard format for this data. Please use at your own risk.
      * @type {{ [key: string]: any; }}
      * @memberof Account
+     * @deprecated
      */
     'meta'?: {
         [key: string]: any;

package/dist/models/balance-currency.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The currency of the balance. This applies to both `cash` and `buying_power`.
+ * @export
+ * @interface BalanceCurrency
+ */
+export interface BalanceCurrency {
+    /**
+     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+     * @type {string}
+     * @memberof BalanceCurrency
+     */
+    'id'?: string;
+    /**
+     * The ISO-4217 currency code for the currency.
+     * @type {string}
+     * @memberof BalanceCurrency
+     */
+    'code'?: string;
+    /**
+     * A human-friendly name of the currency.
+     * @type {string}
+     * @memberof BalanceCurrency
+     */
+    'name'?: string;
+}

package/dist/models/balance.d.ts

@@ -1,4 +1,4 @@
-import { Currency } from './currency';
+import { BalanceCurrency } from './balance-currency';
 /**
  * Holds balance information for a single currency in an account.
  * @export
@@ -8,10 +8,10 @@ export interface Balance {
     [key: string]: any;
     /**
      *
-     * @type {Currency}
+     * @type {BalanceCurrency}
      * @memberof Balance
      */
-    'currency'?: Currency;
+    'currency'?: BalanceCurrency;
     /**
      * The amount of available cash in the account denominated in the currency of the `currency` field.
      * @type {number}

package/dist/models/holdings-status.d.ts

@@ -1,19 +1,19 @@
 /**
- * Status of account holdings sync
+ * Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
  * @export
  * @interface HoldingsStatus
  */
 export interface HoldingsStatus {
     /**
-     *
+     * Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete.
      * @type {boolean}
      * @memberof HoldingsStatus
      */
     'initial_sync_completed'?: boolean;
     /**
-     * Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
+     * The last time holdings were successfully synced by SnapTrade.
      * @type {string}
      * @memberof HoldingsStatus
      */
-    'last_successful_sync'?: string | null;
+    'last_successful_sync'?: string;
 }

package/dist/models/index.d.ts

@@ -10,9 +10,9 @@ export * from './account-order-record-universal-symbol';
 export * from './account-simple';
 export * from './account-sync-status';
 export * from './action-strict';
-export * from './amount';
 export * from './authentication-login-snap-trade-user200-response';
 export * from './balance';
+export * from './balance-currency';
 export * from './brokerage';
 export * from './brokerage-authorization';
 export * from './brokerage-authorization-disabled-confirmation';
@@ -70,8 +70,6 @@ export * from './position-symbol';
 export * from './security-type';
 export * from './session-event';
 export * from './snap-trade-holdings-account';
-export * from './snap-trade-holdings-account-account-id';
-export * from './snap-trade-holdings-account-account-id-balance';
 export * from './snap-trade-holdings-total-value';
 export * from './snap-trade-login-user-request-body';
 export * from './snap-trade-register-user-request-body';

package/dist/models/index.js

@@ -26,9 +26,9 @@ __exportStar(require("./account-order-record-universal-symbol"), exports);
 __exportStar(require("./account-simple"), exports);
 __exportStar(require("./account-sync-status"), exports);
 __exportStar(require("./action-strict"), exports);
-__exportStar(require("./amount"), exports);
 __exportStar(require("./authentication-login-snap-trade-user200-response"), exports);
 __exportStar(require("./balance"), exports);
+__exportStar(require("./balance-currency"), exports);
 __exportStar(require("./brokerage"), exports);
 __exportStar(require("./brokerage-authorization"), exports);
 __exportStar(require("./brokerage-authorization-disabled-confirmation"), exports);
@@ -86,8 +86,6 @@ __exportStar(require("./position-symbol"), exports);
 __exportStar(require("./security-type"), exports);
 __exportStar(require("./session-event"), exports);
 __exportStar(require("./snap-trade-holdings-account"), exports);
-__exportStar(require("./snap-trade-holdings-account-account-id"), exports);
-__exportStar(require("./snap-trade-holdings-account-account-id-balance"), exports);
 __exportStar(require("./snap-trade-holdings-total-value"), exports);
 __exportStar(require("./snap-trade-login-user-request-body"), exports);
 __exportStar(require("./snap-trade-register-user-request-body"), exports);

package/dist/models/transactions-status.d.ts

@@ -1,25 +1,25 @@
 /**
- * Status of account transaction sync
+ * Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
  * @export
  * @interface TransactionsStatus
  */
 export interface TransactionsStatus {
     /**
-     *
+     * Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete.
      * @type {boolean}
      * @memberof TransactionsStatus
      */
     'initial_sync_completed'?: boolean;
     /**
-     * Date in YYYY-MM-DD format or null
+     * All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions.
      * @type {string}
      * @memberof TransactionsStatus
      */
-    'last_successful_sync'?: string | null;
+    'last_successful_sync'?: string;
     /**
-     * Date in YYYY-MM-DD format or null
+     * The date of the first transaction in the account known to SnapTrade. It\'s possible that the account has transactions before this date, but they are not known to SnapTrade.
      * @type {string}
      * @memberof TransactionsStatus
      */
-    'first_transaction_date'?: string | null;
+    'first_transaction_date'?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "9.0.34",
+  "version": "9.0.35",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "engines": {

package/dist/models/amount.d.ts

@@ -1,19 +0,0 @@
-/**
- * Total value of the account, as reported by the brokerage
- * @export
- * @interface Amount
- */
-export interface Amount {
-    /**
-     * Total value denominated in the currency of the `currency` field.
-     * @type {number}
-     * @memberof Amount
-     */
-    'amount'?: number;
-    /**
-     * The ISO-4217 currency code for the amount.
-     * @type {string}
-     * @memberof Amount
-     */
-    'currency'?: string;
-}

package/dist/models/snap-trade-holdings-account-account-id-balance.d.ts

@@ -1,14 +0,0 @@
-import { AccountBalanceTotal } from './account-balance-total';
-/**
- *
- * @export
- * @interface SnapTradeHoldingsAccountAccountIdBalance
- */
-export interface SnapTradeHoldingsAccountAccountIdBalance {
-    /**
-     *
-     * @type {AccountBalanceTotal}
-     * @memberof SnapTradeHoldingsAccountAccountIdBalance
-     */
-    'total'?: AccountBalanceTotal | null;
-}

package/dist/models/snap-trade-holdings-account-account-id-balance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/snap-trade-holdings-account-account-id.d.ts

@@ -1,74 +0,0 @@
-import { SnapTradeHoldingsAccountAccountIdBalance } from './snap-trade-holdings-account-account-id-balance';
-/**
- * A single brokerage account at a financial institution.
- * @export
- * @interface SnapTradeHoldingsAccountAccountId
- */
-export interface SnapTradeHoldingsAccountAccountId {
-    [key: string]: any;
-    /**
-     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'id'?: string;
-    /**
-     * Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'brokerage_authorization'?: string;
-    /**
-     * Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     * @deprecated
-     */
-    'portfolio_group'?: string;
-    /**
-     * A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'name'?: string | null;
-    /**
-     * The account number assigned by the financial institution.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'number'?: string;
-    /**
-     * The name of the financial institution that holds the account.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'institution_name'?: string;
-    /**
-     *
-     * @type {SnapTradeHoldingsAccountAccountIdBalance}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'balance'?: SnapTradeHoldingsAccountAccountIdBalance | null;
-    /**
-     * Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there\'s no standard format for this data. Please use at your own risk.
-     * @type {{ [key: string]: any; }}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     * @deprecated
-     */
-    'meta'?: {
-        [key: string]: any;
-    };
-    /**
-     * This field is deprecated.
-     * @type {Array<string>}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     * @deprecated
-     */
-    'cash_restrictions'?: Array<string>;
-    /**
-     * 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 financial institution.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'created_date'?: string;
-}

package/dist/models/snap-trade-holdings-account-account-id.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });